1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581245822458324584245852458624587245882458924590245912459224593245942459524596245972459824599246002460124602246032460424605246062460724608246092461024611246122461324614246152461624617246182461924620246212462224623246242462524626246272462824629246302463124632246332463424635246362463724638246392464024641246422464324644246452464624647246482464924650246512465224653246542465524656246572465824659246602466124662246632466424665246662466724668246692467024671246722467324674246752467624677246782467924680246812468224683246842468524686246872468824689246902469124692246932469424695246962469724698246992470024701247022470324704247052470624707247082470924710247112471224713247142471524716247172471824719247202472124722247232472424725247262472724728247292473024731247322473324734247352473624737247382473924740247412474224743247442474524746247472474824749247502475124752247532475424755247562475724758247592476024761247622476324764247652476624767247682476924770247712477224773247742477524776247772477824779247802478124782247832478424785247862478724788247892479024791247922479324794247952479624797247982479924800248012480224803248042480524806248072480824809248102481124812248132481424815248162481724818248192482024821248222482324824248252482624827248282482924830248312483224833248342483524836248372483824839248402484124842248432484424845248462484724848248492485024851248522485324854248552485624857248582485924860248612486224863248642486524866248672486824869248702487124872248732487424875248762487724878248792488024881248822488324884248852488624887248882488924890248912489224893248942489524896248972489824899249002490124902249032490424905249062490724908249092491024911249122491324914249152491624917249182491924920249212492224923249242492524926249272492824929249302493124932249332493424935249362493724938249392494024941249422494324944249452494624947249482494924950249512495224953249542495524956249572495824959249602496124962249632496424965249662496724968249692497024971249722497324974249752497624977249782497924980249812498224983249842498524986249872498824989249902499124992249932499424995249962499724998249992500025001250022500325004250052500625007250082500925010250112501225013250142501525016250172501825019250202502125022250232502425025250262502725028250292503025031250322503325034250352503625037250382503925040250412504225043250442504525046250472504825049250502505125052250532505425055250562505725058250592506025061250622506325064250652506625067250682506925070250712507225073250742507525076250772507825079250802508125082250832508425085250862508725088250892509025091250922509325094250952509625097250982509925100251012510225103251042510525106251072510825109251102511125112251132511425115251162511725118251192512025121251222512325124251252512625127251282512925130251312513225133251342513525136251372513825139251402514125142251432514425145251462514725148251492515025151251522515325154251552515625157251582515925160251612516225163251642516525166251672516825169251702517125172251732517425175251762517725178251792518025181251822518325184251852518625187251882518925190251912519225193251942519525196251972519825199252002520125202252032520425205252062520725208252092521025211252122521325214252152521625217252182521925220252212522225223252242522525226252272522825229252302523125232252332523425235252362523725238252392524025241252422524325244252452524625247252482524925250252512525225253252542525525256252572525825259252602526125262252632526425265252662526725268252692527025271252722527325274252752527625277252782527925280252812528225283252842528525286252872528825289252902529125292252932529425295252962529725298252992530025301253022530325304253052530625307253082530925310253112531225313253142531525316253172531825319253202532125322253232532425325253262532725328253292533025331253322533325334253352533625337253382533925340253412534225343253442534525346253472534825349253502535125352253532535425355253562535725358253592536025361253622536325364253652536625367253682536925370253712537225373253742537525376253772537825379253802538125382253832538425385253862538725388253892539025391253922539325394253952539625397253982539925400254012540225403254042540525406254072540825409254102541125412254132541425415254162541725418254192542025421254222542325424254252542625427254282542925430254312543225433254342543525436254372543825439254402544125442254432544425445254462544725448254492545025451254522545325454254552545625457254582545925460254612546225463254642546525466254672546825469254702547125472254732547425475254762547725478254792548025481254822548325484254852548625487254882548925490254912549225493254942549525496254972549825499255002550125502255032550425505255062550725508255092551025511255122551325514255152551625517255182551925520255212552225523255242552525526255272552825529255302553125532255332553425535255362553725538255392554025541255422554325544255452554625547255482554925550255512555225553255542555525556255572555825559255602556125562255632556425565255662556725568255692557025571255722557325574255752557625577255782557925580255812558225583255842558525586255872558825589255902559125592255932559425595255962559725598255992560025601256022560325604256052560625607256082560925610256112561225613256142561525616256172561825619256202562125622256232562425625256262562725628256292563025631256322563325634256352563625637256382563925640256412564225643256442564525646256472564825649256502565125652256532565425655256562565725658256592566025661256622566325664256652566625667256682566925670256712567225673256742567525676256772567825679256802568125682256832568425685256862568725688256892569025691256922569325694256952569625697256982569925700257012570225703257042570525706257072570825709257102571125712257132571425715257162571725718257192572025721257222572325724257252572625727257282572925730257312573225733257342573525736257372573825739257402574125742257432574425745257462574725748257492575025751257522575325754257552575625757257582575925760257612576225763257642576525766257672576825769257702577125772257732577425775257762577725778257792578025781257822578325784257852578625787257882578925790257912579225793257942579525796257972579825799258002580125802258032580425805258062580725808258092581025811258122581325814258152581625817258182581925820258212582225823258242582525826258272582825829258302583125832258332583425835258362583725838258392584025841258422584325844258452584625847258482584925850258512585225853258542585525856258572585825859258602586125862258632586425865258662586725868258692587025871258722587325874258752587625877258782587925880258812588225883258842588525886258872588825889258902589125892258932589425895258962589725898258992590025901259022590325904259052590625907259082590925910259112591225913259142591525916259172591825919259202592125922259232592425925259262592725928259292593025931259322593325934259352593625937259382593925940259412594225943259442594525946259472594825949259502595125952259532595425955259562595725958259592596025961259622596325964259652596625967259682596925970259712597225973259742597525976259772597825979259802598125982259832598425985259862598725988259892599025991259922599325994259952599625997259982599926000260012600226003260042600526006260072600826009260102601126012260132601426015260162601726018260192602026021260222602326024260252602626027260282602926030260312603226033260342603526036260372603826039260402604126042260432604426045260462604726048260492605026051260522605326054260552605626057260582605926060260612606226063260642606526066260672606826069260702607126072260732607426075260762607726078260792608026081260822608326084260852608626087260882608926090260912609226093260942609526096260972609826099261002610126102261032610426105261062610726108261092611026111261122611326114261152611626117261182611926120261212612226123261242612526126261272612826129261302613126132261332613426135261362613726138261392614026141261422614326144261452614626147261482614926150261512615226153261542615526156261572615826159261602616126162261632616426165261662616726168261692617026171261722617326174261752617626177261782617926180261812618226183261842618526186261872618826189261902619126192261932619426195261962619726198261992620026201262022620326204262052620626207262082620926210262112621226213262142621526216262172621826219262202622126222262232622426225262262622726228262292623026231262322623326234262352623626237262382623926240262412624226243262442624526246262472624826249262502625126252262532625426255262562625726258262592626026261262622626326264262652626626267262682626926270262712627226273262742627526276262772627826279262802628126282262832628426285262862628726288262892629026291262922629326294262952629626297262982629926300263012630226303263042630526306263072630826309263102631126312263132631426315263162631726318263192632026321263222632326324263252632626327263282632926330263312633226333263342633526336263372633826339263402634126342263432634426345263462634726348263492635026351263522635326354263552635626357263582635926360263612636226363263642636526366263672636826369263702637126372263732637426375263762637726378263792638026381263822638326384263852638626387263882638926390263912639226393263942639526396263972639826399264002640126402264032640426405264062640726408264092641026411264122641326414264152641626417264182641926420264212642226423264242642526426264272642826429264302643126432264332643426435264362643726438264392644026441264422644326444264452644626447264482644926450264512645226453264542645526456264572645826459264602646126462264632646426465264662646726468264692647026471264722647326474264752647626477264782647926480264812648226483264842648526486264872648826489264902649126492264932649426495264962649726498264992650026501265022650326504265052650626507265082650926510265112651226513265142651526516265172651826519265202652126522265232652426525265262652726528265292653026531265322653326534265352653626537265382653926540265412654226543265442654526546265472654826549265502655126552265532655426555265562655726558265592656026561265622656326564265652656626567265682656926570265712657226573265742657526576265772657826579265802658126582265832658426585265862658726588265892659026591265922659326594265952659626597265982659926600266012660226603266042660526606266072660826609266102661126612266132661426615266162661726618266192662026621266222662326624266252662626627266282662926630266312663226633266342663526636266372663826639266402664126642266432664426645266462664726648266492665026651266522665326654266552665626657266582665926660266612666226663266642666526666266672666826669266702667126672266732667426675266762667726678266792668026681266822668326684266852668626687266882668926690266912669226693266942669526696266972669826699267002670126702267032670426705267062670726708267092671026711267122671326714267152671626717267182671926720267212672226723267242672526726267272672826729267302673126732267332673426735267362673726738267392674026741267422674326744267452674626747267482674926750267512675226753267542675526756267572675826759267602676126762267632676426765267662676726768267692677026771267722677326774267752677626777267782677926780267812678226783267842678526786267872678826789267902679126792267932679426795267962679726798267992680026801268022680326804268052680626807268082680926810268112681226813268142681526816268172681826819268202682126822268232682426825268262682726828268292683026831268322683326834268352683626837268382683926840268412684226843268442684526846268472684826849268502685126852268532685426855268562685726858268592686026861268622686326864268652686626867268682686926870268712687226873268742687526876268772687826879268802688126882268832688426885268862688726888268892689026891268922689326894268952689626897268982689926900269012690226903269042690526906269072690826909269102691126912269132691426915269162691726918269192692026921269222692326924269252692626927269282692926930269312693226933269342693526936269372693826939269402694126942269432694426945269462694726948269492695026951269522695326954269552695626957269582695926960269612696226963269642696526966269672696826969269702697126972269732697426975269762697726978269792698026981269822698326984269852698626987269882698926990269912699226993269942699526996269972699826999270002700127002270032700427005270062700727008270092701027011270122701327014270152701627017270182701927020270212702227023270242702527026270272702827029270302703127032270332703427035270362703727038270392704027041270422704327044270452704627047270482704927050270512705227053270542705527056270572705827059270602706127062270632706427065270662706727068270692707027071270722707327074270752707627077270782707927080270812708227083270842708527086270872708827089270902709127092270932709427095270962709727098270992710027101271022710327104271052710627107271082710927110271112711227113271142711527116271172711827119271202712127122271232712427125271262712727128271292713027131271322713327134271352713627137271382713927140271412714227143271442714527146271472714827149271502715127152271532715427155271562715727158271592716027161271622716327164271652716627167271682716927170271712717227173271742717527176271772717827179271802718127182271832718427185271862718727188271892719027191271922719327194271952719627197271982719927200272012720227203272042720527206272072720827209272102721127212272132721427215272162721727218272192722027221272222722327224272252722627227272282722927230272312723227233272342723527236272372723827239272402724127242272432724427245272462724727248272492725027251272522725327254272552725627257272582725927260272612726227263272642726527266272672726827269272702727127272272732727427275272762727727278272792728027281272822728327284272852728627287272882728927290272912729227293272942729527296272972729827299273002730127302273032730427305273062730727308273092731027311273122731327314273152731627317273182731927320273212732227323273242732527326273272732827329273302733127332273332733427335273362733727338273392734027341273422734327344273452734627347273482734927350273512735227353273542735527356273572735827359273602736127362273632736427365273662736727368273692737027371273722737327374273752737627377273782737927380273812738227383273842738527386273872738827389273902739127392273932739427395273962739727398273992740027401274022740327404274052740627407274082740927410274112741227413274142741527416274172741827419274202742127422274232742427425274262742727428274292743027431274322743327434274352743627437274382743927440274412744227443274442744527446274472744827449274502745127452274532745427455274562745727458274592746027461274622746327464274652746627467274682746927470274712747227473274742747527476274772747827479274802748127482274832748427485274862748727488274892749027491274922749327494274952749627497274982749927500275012750227503275042750527506275072750827509275102751127512275132751427515275162751727518275192752027521275222752327524275252752627527275282752927530275312753227533275342753527536275372753827539275402754127542275432754427545275462754727548275492755027551275522755327554275552755627557275582755927560275612756227563275642756527566275672756827569275702757127572275732757427575275762757727578275792758027581275822758327584275852758627587275882758927590275912759227593275942759527596275972759827599276002760127602276032760427605276062760727608276092761027611276122761327614276152761627617276182761927620276212762227623276242762527626276272762827629276302763127632276332763427635276362763727638276392764027641276422764327644276452764627647276482764927650276512765227653276542765527656276572765827659276602766127662276632766427665276662766727668276692767027671276722767327674276752767627677276782767927680276812768227683276842768527686276872768827689276902769127692276932769427695276962769727698276992770027701277022770327704277052770627707277082770927710277112771227713277142771527716277172771827719277202772127722277232772427725277262772727728277292773027731277322773327734277352773627737277382773927740277412774227743277442774527746277472774827749277502775127752277532775427755277562775727758277592776027761277622776327764277652776627767277682776927770277712777227773277742777527776277772777827779277802778127782277832778427785277862778727788277892779027791277922779327794277952779627797277982779927800278012780227803278042780527806278072780827809278102781127812278132781427815278162781727818278192782027821278222782327824278252782627827278282782927830278312783227833278342783527836278372783827839278402784127842278432784427845278462784727848278492785027851278522785327854278552785627857278582785927860278612786227863278642786527866278672786827869278702787127872278732787427875278762787727878278792788027881278822788327884278852788627887278882788927890278912789227893278942789527896278972789827899279002790127902279032790427905279062790727908279092791027911279122791327914279152791627917279182791927920279212792227923279242792527926279272792827929279302793127932279332793427935279362793727938279392794027941279422794327944279452794627947279482794927950279512795227953279542795527956279572795827959279602796127962279632796427965279662796727968279692797027971279722797327974279752797627977279782797927980279812798227983279842798527986279872798827989279902799127992279932799427995279962799727998279992800028001280022800328004280052800628007280082800928010280112801228013280142801528016280172801828019280202802128022280232802428025280262802728028280292803028031280322803328034280352803628037280382803928040280412804228043280442804528046280472804828049280502805128052280532805428055280562805728058280592806028061280622806328064280652806628067280682806928070280712807228073280742807528076280772807828079280802808128082280832808428085280862808728088280892809028091280922809328094280952809628097280982809928100281012810228103281042810528106281072810828109281102811128112281132811428115281162811728118281192812028121281222812328124281252812628127281282812928130281312813228133281342813528136281372813828139281402814128142281432814428145281462814728148281492815028151281522815328154281552815628157281582815928160281612816228163281642816528166281672816828169281702817128172281732817428175281762817728178281792818028181281822818328184281852818628187281882818928190281912819228193281942819528196281972819828199282002820128202282032820428205282062820728208282092821028211282122821328214282152821628217282182821928220282212822228223282242822528226282272822828229282302823128232282332823428235282362823728238282392824028241282422824328244282452824628247282482824928250282512825228253282542825528256282572825828259282602826128262282632826428265282662826728268282692827028271282722827328274282752827628277282782827928280282812828228283282842828528286282872828828289282902829128292282932829428295282962829728298282992830028301283022830328304283052830628307283082830928310283112831228313283142831528316283172831828319283202832128322283232832428325283262832728328283292833028331283322833328334283352833628337283382833928340283412834228343283442834528346283472834828349283502835128352283532835428355283562835728358283592836028361283622836328364283652836628367283682836928370283712837228373283742837528376283772837828379283802838128382283832838428385283862838728388283892839028391283922839328394283952839628397283982839928400284012840228403284042840528406284072840828409284102841128412284132841428415284162841728418284192842028421284222842328424284252842628427284282842928430284312843228433284342843528436284372843828439284402844128442284432844428445284462844728448284492845028451284522845328454284552845628457284582845928460284612846228463284642846528466284672846828469284702847128472284732847428475284762847728478284792848028481284822848328484284852848628487284882848928490284912849228493284942849528496284972849828499285002850128502285032850428505285062850728508285092851028511285122851328514285152851628517285182851928520285212852228523285242852528526285272852828529285302853128532285332853428535285362853728538285392854028541285422854328544285452854628547285482854928550285512855228553285542855528556285572855828559285602856128562285632856428565285662856728568285692857028571285722857328574285752857628577285782857928580285812858228583285842858528586285872858828589285902859128592285932859428595285962859728598285992860028601286022860328604286052860628607286082860928610286112861228613286142861528616286172861828619286202862128622286232862428625286262862728628286292863028631286322863328634286352863628637286382863928640286412864228643286442864528646286472864828649286502865128652286532865428655286562865728658286592866028661286622866328664286652866628667286682866928670286712867228673286742867528676286772867828679286802868128682286832868428685286862868728688286892869028691286922869328694286952869628697286982869928700287012870228703287042870528706287072870828709287102871128712287132871428715287162871728718287192872028721287222872328724287252872628727287282872928730287312873228733287342873528736287372873828739287402874128742287432874428745287462874728748287492875028751287522875328754287552875628757287582875928760287612876228763287642876528766287672876828769287702877128772287732877428775287762877728778287792878028781287822878328784287852878628787287882878928790287912879228793287942879528796287972879828799288002880128802288032880428805288062880728808288092881028811288122881328814288152881628817288182881928820288212882228823288242882528826288272882828829288302883128832288332883428835288362883728838288392884028841288422884328844288452884628847288482884928850288512885228853288542885528856288572885828859288602886128862288632886428865288662886728868288692887028871288722887328874288752887628877288782887928880288812888228883288842888528886288872888828889288902889128892288932889428895288962889728898288992890028901289022890328904289052890628907289082890928910289112891228913289142891528916289172891828919289202892128922289232892428925289262892728928289292893028931289322893328934289352893628937289382893928940289412894228943289442894528946289472894828949289502895128952289532895428955289562895728958289592896028961289622896328964289652896628967289682896928970289712897228973289742897528976289772897828979289802898128982289832898428985289862898728988289892899028991289922899328994289952899628997289982899929000290012900229003290042900529006290072900829009290102901129012290132901429015290162901729018290192902029021290222902329024290252902629027290282902929030290312903229033290342903529036290372903829039290402904129042290432904429045290462904729048290492905029051290522905329054290552905629057290582905929060290612906229063290642906529066290672906829069290702907129072290732907429075290762907729078290792908029081290822908329084290852908629087290882908929090290912909229093290942909529096290972909829099291002910129102291032910429105291062910729108291092911029111291122911329114291152911629117291182911929120291212912229123291242912529126291272912829129291302913129132291332913429135291362913729138291392914029141291422914329144291452914629147291482914929150291512915229153291542915529156291572915829159291602916129162291632916429165291662916729168291692917029171291722917329174291752917629177291782917929180291812918229183291842918529186291872918829189291902919129192291932919429195291962919729198291992920029201292022920329204292052920629207292082920929210292112921229213292142921529216292172921829219292202922129222292232922429225292262922729228292292923029231292322923329234292352923629237292382923929240292412924229243292442924529246292472924829249292502925129252292532925429255292562925729258292592926029261292622926329264292652926629267292682926929270292712927229273292742927529276292772927829279292802928129282292832928429285292862928729288292892929029291292922929329294292952929629297292982929929300293012930229303293042930529306293072930829309293102931129312293132931429315293162931729318293192932029321293222932329324293252932629327293282932929330293312933229333293342933529336293372933829339293402934129342293432934429345293462934729348293492935029351293522935329354293552935629357293582935929360293612936229363293642936529366293672936829369293702937129372293732937429375293762937729378293792938029381293822938329384293852938629387293882938929390293912939229393293942939529396293972939829399294002940129402294032940429405294062940729408294092941029411294122941329414294152941629417294182941929420294212942229423294242942529426294272942829429294302943129432294332943429435294362943729438294392944029441294422944329444294452944629447294482944929450294512945229453294542945529456294572945829459294602946129462294632946429465294662946729468294692947029471294722947329474294752947629477294782947929480294812948229483294842948529486294872948829489294902949129492294932949429495294962949729498294992950029501295022950329504295052950629507295082950929510295112951229513295142951529516295172951829519295202952129522295232952429525295262952729528295292953029531295322953329534295352953629537295382953929540295412954229543295442954529546295472954829549295502955129552295532955429555295562955729558295592956029561295622956329564295652956629567295682956929570295712957229573295742957529576295772957829579295802958129582295832958429585295862958729588295892959029591295922959329594295952959629597295982959929600296012960229603296042960529606296072960829609296102961129612296132961429615296162961729618296192962029621296222962329624296252962629627296282962929630296312963229633296342963529636296372963829639296402964129642296432964429645296462964729648296492965029651296522965329654296552965629657296582965929660296612966229663296642966529666296672966829669296702967129672296732967429675296762967729678296792968029681296822968329684296852968629687296882968929690296912969229693296942969529696296972969829699297002970129702297032970429705297062970729708297092971029711297122971329714297152971629717297182971929720297212972229723297242972529726297272972829729297302973129732297332973429735297362973729738297392974029741297422974329744297452974629747297482974929750297512975229753297542975529756297572975829759297602976129762297632976429765297662976729768297692977029771297722977329774297752977629777297782977929780297812978229783297842978529786297872978829789297902979129792297932979429795297962979729798297992980029801298022980329804298052980629807298082980929810298112981229813298142981529816298172981829819298202982129822298232982429825298262982729828298292983029831298322983329834298352983629837298382983929840298412984229843298442984529846298472984829849298502985129852298532985429855298562985729858298592986029861298622986329864298652986629867298682986929870298712987229873298742987529876298772987829879298802988129882298832988429885298862988729888298892989029891298922989329894298952989629897298982989929900299012990229903299042990529906299072990829909299102991129912299132991429915299162991729918299192992029921299222992329924299252992629927299282992929930299312993229933299342993529936299372993829939299402994129942299432994429945299462994729948299492995029951299522995329954299552995629957299582995929960299612996229963299642996529966299672996829969299702997129972299732997429975299762997729978299792998029981299822998329984299852998629987299882998929990299912999229993299942999529996299972999829999300003000130002300033000430005300063000730008300093001030011300123001330014300153001630017300183001930020300213002230023300243002530026300273002830029300303003130032300333003430035300363003730038300393004030041300423004330044300453004630047300483004930050300513005230053300543005530056300573005830059300603006130062300633006430065300663006730068300693007030071300723007330074300753007630077300783007930080300813008230083300843008530086300873008830089300903009130092300933009430095300963009730098300993010030101301023010330104301053010630107301083010930110301113011230113301143011530116301173011830119301203012130122301233012430125301263012730128301293013030131301323013330134301353013630137301383013930140301413014230143301443014530146301473014830149301503015130152301533015430155301563015730158301593016030161301623016330164301653016630167301683016930170301713017230173301743017530176301773017830179301803018130182301833018430185301863018730188301893019030191301923019330194301953019630197301983019930200302013020230203302043020530206302073020830209302103021130212302133021430215302163021730218302193022030221302223022330224302253022630227302283022930230302313023230233302343023530236302373023830239302403024130242302433024430245302463024730248302493025030251302523025330254302553025630257302583025930260302613026230263302643026530266302673026830269302703027130272302733027430275302763027730278302793028030281302823028330284302853028630287302883028930290302913029230293302943029530296302973029830299303003030130302303033030430305303063030730308303093031030311303123031330314303153031630317303183031930320303213032230323303243032530326303273032830329303303033130332303333033430335303363033730338303393034030341303423034330344303453034630347303483034930350303513035230353303543035530356303573035830359303603036130362303633036430365303663036730368303693037030371303723037330374303753037630377303783037930380303813038230383303843038530386303873038830389303903039130392303933039430395303963039730398303993040030401304023040330404304053040630407304083040930410304113041230413304143041530416304173041830419304203042130422304233042430425304263042730428304293043030431304323043330434304353043630437304383043930440304413044230443304443044530446304473044830449304503045130452304533045430455304563045730458304593046030461304623046330464304653046630467304683046930470304713047230473304743047530476304773047830479304803048130482304833048430485304863048730488304893049030491304923049330494304953049630497304983049930500305013050230503305043050530506305073050830509305103051130512305133051430515305163051730518305193052030521305223052330524305253052630527305283052930530305313053230533305343053530536305373053830539305403054130542305433054430545305463054730548305493055030551305523055330554305553055630557305583055930560305613056230563305643056530566305673056830569305703057130572305733057430575305763057730578305793058030581305823058330584305853058630587305883058930590305913059230593305943059530596305973059830599306003060130602306033060430605306063060730608306093061030611306123061330614306153061630617306183061930620306213062230623306243062530626306273062830629306303063130632306333063430635306363063730638306393064030641306423064330644306453064630647306483064930650306513065230653306543065530656306573065830659306603066130662306633066430665306663066730668306693067030671306723067330674306753067630677306783067930680306813068230683306843068530686306873068830689306903069130692306933069430695306963069730698306993070030701307023070330704307053070630707307083070930710307113071230713307143071530716307173071830719307203072130722307233072430725307263072730728307293073030731307323073330734307353073630737307383073930740307413074230743307443074530746307473074830749307503075130752307533075430755307563075730758307593076030761307623076330764307653076630767307683076930770307713077230773307743077530776307773077830779307803078130782307833078430785307863078730788307893079030791307923079330794307953079630797307983079930800308013080230803308043080530806308073080830809308103081130812308133081430815308163081730818308193082030821308223082330824308253082630827308283082930830308313083230833308343083530836308373083830839308403084130842308433084430845308463084730848308493085030851308523085330854308553085630857308583085930860308613086230863308643086530866308673086830869308703087130872308733087430875308763087730878308793088030881308823088330884308853088630887308883088930890308913089230893308943089530896308973089830899309003090130902309033090430905309063090730908309093091030911309123091330914309153091630917309183091930920309213092230923309243092530926309273092830929309303093130932309333093430935309363093730938309393094030941309423094330944309453094630947309483094930950309513095230953309543095530956309573095830959309603096130962309633096430965309663096730968309693097030971309723097330974309753097630977309783097930980309813098230983309843098530986309873098830989309903099130992309933099430995309963099730998309993100031001310023100331004310053100631007310083100931010310113101231013310143101531016310173101831019310203102131022310233102431025310263102731028310293103031031310323103331034310353103631037310383103931040310413104231043310443104531046310473104831049310503105131052310533105431055310563105731058310593106031061310623106331064310653106631067310683106931070310713107231073310743107531076310773107831079310803108131082310833108431085310863108731088310893109031091310923109331094310953109631097310983109931100311013110231103311043110531106311073110831109311103111131112311133111431115311163111731118311193112031121311223112331124311253112631127311283112931130311313113231133311343113531136311373113831139311403114131142311433114431145311463114731148311493115031151311523115331154311553115631157311583115931160311613116231163311643116531166311673116831169311703117131172311733117431175311763117731178311793118031181311823118331184311853118631187311883118931190311913119231193311943119531196311973119831199312003120131202312033120431205312063120731208312093121031211312123121331214312153121631217312183121931220312213122231223312243122531226312273122831229312303123131232312333123431235312363123731238312393124031241312423124331244312453124631247312483124931250312513125231253312543125531256312573125831259312603126131262312633126431265312663126731268312693127031271312723127331274312753127631277312783127931280312813128231283312843128531286312873128831289312903129131292312933129431295312963129731298312993130031301313023130331304313053130631307313083130931310313113131231313313143131531316313173131831319313203132131322313233132431325313263132731328313293133031331313323133331334313353133631337313383133931340313413134231343313443134531346313473134831349313503135131352313533135431355313563135731358313593136031361313623136331364313653136631367313683136931370313713137231373313743137531376313773137831379313803138131382313833138431385313863138731388313893139031391313923139331394313953139631397313983139931400314013140231403314043140531406314073140831409314103141131412314133141431415314163141731418314193142031421314223142331424314253142631427314283142931430314313143231433314343143531436314373143831439314403144131442314433144431445314463144731448314493145031451314523145331454314553145631457314583145931460314613146231463314643146531466314673146831469314703147131472314733147431475314763147731478314793148031481314823148331484314853148631487314883148931490314913149231493314943149531496314973149831499315003150131502315033150431505315063150731508315093151031511315123151331514315153151631517315183151931520315213152231523315243152531526315273152831529315303153131532315333153431535315363153731538315393154031541315423154331544315453154631547315483154931550315513155231553315543155531556315573155831559315603156131562315633156431565315663156731568315693157031571315723157331574315753157631577315783157931580315813158231583315843158531586315873158831589315903159131592315933159431595315963159731598315993160031601316023160331604316053160631607316083160931610316113161231613316143161531616316173161831619316203162131622316233162431625316263162731628316293163031631316323163331634316353163631637316383163931640316413164231643316443164531646316473164831649316503165131652316533165431655316563165731658316593166031661316623166331664316653166631667316683166931670316713167231673316743167531676316773167831679316803168131682316833168431685316863168731688316893169031691316923169331694316953169631697316983169931700317013170231703317043170531706317073170831709317103171131712317133171431715317163171731718317193172031721317223172331724317253172631727317283172931730317313173231733317343173531736317373173831739317403174131742317433174431745317463174731748317493175031751317523175331754317553175631757317583175931760317613176231763317643176531766317673176831769317703177131772317733177431775317763177731778317793178031781317823178331784317853178631787317883178931790317913179231793317943179531796317973179831799318003180131802318033180431805318063180731808318093181031811318123181331814318153181631817318183181931820318213182231823318243182531826318273182831829318303183131832318333183431835318363183731838318393184031841318423184331844318453184631847318483184931850318513185231853318543185531856318573185831859318603186131862318633186431865318663186731868318693187031871318723187331874318753187631877318783187931880318813188231883318843188531886318873188831889318903189131892318933189431895318963189731898318993190031901319023190331904319053190631907319083190931910319113191231913319143191531916319173191831919319203192131922319233192431925319263192731928319293193031931319323193331934319353193631937319383193931940319413194231943319443194531946319473194831949319503195131952319533195431955319563195731958319593196031961319623196331964319653196631967319683196931970319713197231973319743197531976319773197831979319803198131982319833198431985319863198731988319893199031991319923199331994319953199631997319983199932000320013200232003320043200532006320073200832009320103201132012320133201432015320163201732018320193202032021320223202332024320253202632027320283202932030320313203232033320343203532036320373203832039320403204132042320433204432045320463204732048320493205032051320523205332054320553205632057320583205932060320613206232063320643206532066320673206832069320703207132072320733207432075320763207732078320793208032081320823208332084320853208632087320883208932090320913209232093320943209532096320973209832099321003210132102321033210432105321063210732108321093211032111321123211332114321153211632117321183211932120321213212232123321243212532126321273212832129321303213132132321333213432135321363213732138321393214032141321423214332144321453214632147321483214932150321513215232153321543215532156321573215832159321603216132162321633216432165321663216732168321693217032171321723217332174321753217632177321783217932180321813218232183321843218532186321873218832189321903219132192321933219432195321963219732198321993220032201322023220332204322053220632207322083220932210322113221232213322143221532216322173221832219322203222132222322233222432225322263222732228322293223032231322323223332234322353223632237322383223932240322413224232243322443224532246322473224832249322503225132252322533225432255322563225732258322593226032261322623226332264322653226632267322683226932270322713227232273322743227532276322773227832279322803228132282322833228432285322863228732288322893229032291322923229332294322953229632297322983229932300323013230232303323043230532306323073230832309323103231132312323133231432315323163231732318323193232032321323223232332324323253232632327323283232932330323313233232333323343233532336323373233832339323403234132342323433234432345323463234732348323493235032351323523235332354323553235632357323583235932360323613236232363323643236532366323673236832369323703237132372323733237432375323763237732378323793238032381323823238332384323853238632387323883238932390323913239232393323943239532396323973239832399324003240132402324033240432405324063240732408324093241032411324123241332414324153241632417324183241932420324213242232423324243242532426324273242832429324303243132432324333243432435324363243732438324393244032441324423244332444324453244632447324483244932450324513245232453324543245532456324573245832459324603246132462324633246432465324663246732468324693247032471324723247332474324753247632477324783247932480324813248232483324843248532486324873248832489324903249132492324933249432495324963249732498324993250032501325023250332504325053250632507325083250932510325113251232513325143251532516325173251832519325203252132522325233252432525325263252732528325293253032531325323253332534325353253632537325383253932540325413254232543325443254532546325473254832549325503255132552325533255432555325563255732558325593256032561325623256332564325653256632567325683256932570325713257232573325743257532576325773257832579325803258132582325833258432585325863258732588325893259032591325923259332594325953259632597325983259932600326013260232603326043260532606326073260832609326103261132612326133261432615326163261732618326193262032621326223262332624326253262632627326283262932630326313263232633326343263532636326373263832639326403264132642326433264432645326463264732648326493265032651326523265332654326553265632657326583265932660326613266232663326643266532666326673266832669326703267132672326733267432675326763267732678326793268032681326823268332684326853268632687326883268932690326913269232693326943269532696326973269832699327003270132702327033270432705327063270732708327093271032711327123271332714327153271632717327183271932720327213272232723327243272532726327273272832729327303273132732327333273432735327363273732738327393274032741327423274332744327453274632747327483274932750327513275232753327543275532756327573275832759327603276132762327633276432765327663276732768327693277032771327723277332774327753277632777327783277932780327813278232783327843278532786327873278832789327903279132792327933279432795327963279732798327993280032801328023280332804328053280632807328083280932810328113281232813328143281532816328173281832819328203282132822328233282432825328263282732828328293283032831328323283332834328353283632837328383283932840328413284232843328443284532846328473284832849328503285132852328533285432855328563285732858328593286032861328623286332864328653286632867328683286932870328713287232873328743287532876328773287832879328803288132882328833288432885328863288732888328893289032891328923289332894328953289632897328983289932900329013290232903329043290532906329073290832909329103291132912329133291432915329163291732918329193292032921329223292332924329253292632927329283292932930329313293232933329343293532936329373293832939329403294132942329433294432945329463294732948329493295032951329523295332954329553295632957329583295932960329613296232963329643296532966329673296832969329703297132972329733297432975329763297732978329793298032981329823298332984329853298632987329883298932990329913299232993329943299532996329973299832999330003300133002330033300433005330063300733008330093301033011330123301333014330153301633017330183301933020330213302233023330243302533026330273302833029330303303133032330333303433035330363303733038330393304033041330423304333044330453304633047330483304933050330513305233053330543305533056330573305833059330603306133062330633306433065330663306733068330693307033071330723307333074330753307633077330783307933080330813308233083330843308533086330873308833089330903309133092330933309433095330963309733098330993310033101331023310333104331053310633107331083310933110331113311233113331143311533116331173311833119331203312133122331233312433125331263312733128331293313033131331323313333134331353313633137331383313933140331413314233143331443314533146331473314833149331503315133152331533315433155331563315733158331593316033161331623316333164331653316633167331683316933170331713317233173331743317533176331773317833179331803318133182331833318433185331863318733188331893319033191331923319333194331953319633197331983319933200332013320233203332043320533206332073320833209332103321133212332133321433215332163321733218332193322033221332223322333224332253322633227332283322933230332313323233233332343323533236332373323833239332403324133242332433324433245332463324733248332493325033251332523325333254332553325633257332583325933260332613326233263332643326533266332673326833269332703327133272332733327433275332763327733278332793328033281332823328333284332853328633287332883328933290332913329233293332943329533296332973329833299333003330133302333033330433305333063330733308333093331033311333123331333314333153331633317333183331933320333213332233323333243332533326333273332833329333303333133332333333333433335333363333733338333393334033341333423334333344333453334633347333483334933350333513335233353333543335533356333573335833359333603336133362333633336433365333663336733368333693337033371333723337333374333753337633377333783337933380333813338233383333843338533386333873338833389333903339133392333933339433395333963339733398333993340033401334023340333404334053340633407334083340933410334113341233413334143341533416334173341833419334203342133422334233342433425334263342733428334293343033431334323343333434334353343633437334383343933440334413344233443334443344533446334473344833449334503345133452334533345433455334563345733458334593346033461334623346333464334653346633467334683346933470334713347233473334743347533476334773347833479334803348133482334833348433485334863348733488334893349033491334923349333494334953349633497334983349933500335013350233503335043350533506335073350833509335103351133512335133351433515335163351733518335193352033521335223352333524335253352633527335283352933530335313353233533335343353533536335373353833539335403354133542335433354433545335463354733548335493355033551335523355333554335553355633557335583355933560335613356233563335643356533566335673356833569335703357133572335733357433575335763357733578335793358033581335823358333584335853358633587335883358933590335913359233593335943359533596335973359833599336003360133602336033360433605336063360733608336093361033611336123361333614336153361633617336183361933620336213362233623336243362533626336273362833629336303363133632336333363433635336363363733638336393364033641336423364333644336453364633647336483364933650336513365233653336543365533656336573365833659336603366133662336633366433665336663366733668336693367033671336723367333674336753367633677336783367933680336813368233683336843368533686336873368833689336903369133692336933369433695336963369733698336993370033701337023370333704337053370633707337083370933710337113371233713337143371533716337173371833719337203372133722337233372433725337263372733728337293373033731337323373333734337353373633737337383373933740337413374233743337443374533746337473374833749337503375133752337533375433755337563375733758337593376033761337623376333764337653376633767337683376933770337713377233773337743377533776337773377833779337803378133782337833378433785337863378733788337893379033791337923379333794337953379633797337983379933800338013380233803338043380533806338073380833809338103381133812338133381433815338163381733818338193382033821338223382333824338253382633827338283382933830338313383233833338343383533836338373383833839338403384133842338433384433845338463384733848338493385033851338523385333854338553385633857338583385933860338613386233863338643386533866338673386833869338703387133872338733387433875338763387733878338793388033881338823388333884338853388633887338883388933890338913389233893338943389533896338973389833899339003390133902339033390433905339063390733908339093391033911339123391333914339153391633917339183391933920339213392233923339243392533926339273392833929339303393133932339333393433935339363393733938339393394033941339423394333944339453394633947339483394933950339513395233953339543395533956339573395833959339603396133962339633396433965339663396733968339693397033971339723397333974339753397633977339783397933980339813398233983339843398533986339873398833989339903399133992339933399433995339963399733998339993400034001340023400334004340053400634007340083400934010340113401234013340143401534016340173401834019340203402134022340233402434025340263402734028340293403034031340323403334034340353403634037340383403934040340413404234043340443404534046340473404834049340503405134052340533405434055340563405734058340593406034061340623406334064340653406634067340683406934070340713407234073340743407534076340773407834079340803408134082340833408434085340863408734088340893409034091340923409334094340953409634097340983409934100341013410234103341043410534106341073410834109341103411134112341133411434115341163411734118341193412034121341223412334124341253412634127341283412934130341313413234133341343413534136341373413834139341403414134142341433414434145341463414734148341493415034151341523415334154341553415634157341583415934160341613416234163341643416534166341673416834169341703417134172341733417434175341763417734178341793418034181341823418334184341853418634187341883418934190341913419234193341943419534196341973419834199342003420134202342033420434205342063420734208342093421034211342123421334214342153421634217342183421934220342213422234223342243422534226342273422834229342303423134232342333423434235342363423734238342393424034241342423424334244342453424634247342483424934250342513425234253342543425534256342573425834259342603426134262342633426434265342663426734268342693427034271342723427334274342753427634277342783427934280342813428234283342843428534286342873428834289342903429134292342933429434295342963429734298342993430034301343023430334304343053430634307343083430934310343113431234313343143431534316343173431834319343203432134322343233432434325343263432734328343293433034331343323433334334343353433634337343383433934340343413434234343343443434534346343473434834349343503435134352343533435434355343563435734358343593436034361343623436334364343653436634367343683436934370343713437234373343743437534376343773437834379343803438134382343833438434385343863438734388343893439034391343923439334394343953439634397343983439934400344013440234403344043440534406344073440834409344103441134412344133441434415344163441734418344193442034421344223442334424344253442634427344283442934430344313443234433344343443534436344373443834439344403444134442344433444434445344463444734448344493445034451344523445334454344553445634457344583445934460344613446234463344643446534466344673446834469344703447134472344733447434475344763447734478344793448034481344823448334484344853448634487344883448934490344913449234493344943449534496344973449834499345003450134502345033450434505345063450734508345093451034511345123451334514345153451634517345183451934520345213452234523345243452534526345273452834529345303453134532345333453434535345363453734538345393454034541345423454334544345453454634547345483454934550345513455234553345543455534556345573455834559345603456134562345633456434565345663456734568345693457034571345723457334574345753457634577345783457934580345813458234583345843458534586345873458834589345903459134592345933459434595345963459734598345993460034601346023460334604346053460634607346083460934610346113461234613346143461534616346173461834619346203462134622346233462434625346263462734628346293463034631346323463334634346353463634637346383463934640346413464234643346443464534646346473464834649346503465134652346533465434655346563465734658346593466034661346623466334664346653466634667346683466934670346713467234673346743467534676346773467834679346803468134682346833468434685346863468734688346893469034691346923469334694346953469634697346983469934700347013470234703347043470534706347073470834709347103471134712347133471434715347163471734718347193472034721347223472334724347253472634727347283472934730347313473234733347343473534736347373473834739347403474134742347433474434745347463474734748347493475034751347523475334754347553475634757347583475934760347613476234763347643476534766347673476834769347703477134772347733477434775347763477734778347793478034781347823478334784347853478634787347883478934790347913479234793347943479534796347973479834799348003480134802348033480434805348063480734808348093481034811348123481334814348153481634817348183481934820348213482234823348243482534826348273482834829348303483134832348333483434835348363483734838348393484034841348423484334844348453484634847348483484934850348513485234853348543485534856348573485834859348603486134862348633486434865348663486734868348693487034871348723487334874348753487634877348783487934880348813488234883348843488534886348873488834889348903489134892348933489434895348963489734898348993490034901349023490334904349053490634907349083490934910349113491234913349143491534916349173491834919349203492134922349233492434925349263492734928349293493034931349323493334934349353493634937349383493934940349413494234943349443494534946349473494834949349503495134952349533495434955349563495734958349593496034961349623496334964349653496634967349683496934970349713497234973349743497534976349773497834979349803498134982349833498434985349863498734988349893499034991349923499334994349953499634997349983499935000350013500235003350043500535006350073500835009350103501135012350133501435015350163501735018350193502035021350223502335024350253502635027350283502935030350313503235033350343503535036350373503835039350403504135042350433504435045350463504735048350493505035051350523505335054350553505635057350583505935060350613506235063350643506535066350673506835069350703507135072350733507435075350763507735078350793508035081350823508335084350853508635087350883508935090350913509235093350943509535096350973509835099351003510135102351033510435105351063510735108351093511035111351123511335114351153511635117351183511935120351213512235123351243512535126351273512835129351303513135132351333513435135351363513735138351393514035141351423514335144351453514635147351483514935150351513515235153351543515535156351573515835159351603516135162351633516435165351663516735168351693517035171351723517335174351753517635177351783517935180351813518235183351843518535186351873518835189351903519135192351933519435195351963519735198351993520035201352023520335204352053520635207352083520935210352113521235213352143521535216352173521835219352203522135222352233522435225352263522735228352293523035231352323523335234352353523635237352383523935240352413524235243352443524535246352473524835249352503525135252352533525435255352563525735258352593526035261352623526335264352653526635267352683526935270352713527235273352743527535276352773527835279352803528135282352833528435285352863528735288352893529035291352923529335294352953529635297352983529935300353013530235303353043530535306353073530835309353103531135312353133531435315353163531735318353193532035321353223532335324353253532635327353283532935330353313533235333353343533535336353373533835339353403534135342353433534435345353463534735348353493535035351353523535335354353553535635357353583535935360353613536235363353643536535366353673536835369353703537135372353733537435375353763537735378353793538035381353823538335384353853538635387353883538935390353913539235393353943539535396353973539835399354003540135402354033540435405354063540735408354093541035411354123541335414354153541635417354183541935420354213542235423354243542535426354273542835429354303543135432354333543435435354363543735438354393544035441354423544335444354453544635447354483544935450354513545235453354543545535456354573545835459354603546135462354633546435465354663546735468354693547035471354723547335474354753547635477354783547935480354813548235483354843548535486354873548835489354903549135492354933549435495354963549735498354993550035501355023550335504355053550635507355083550935510355113551235513355143551535516355173551835519355203552135522355233552435525355263552735528355293553035531355323553335534355353553635537355383553935540355413554235543355443554535546355473554835549355503555135552355533555435555355563555735558355593556035561355623556335564355653556635567355683556935570355713557235573355743557535576355773557835579355803558135582355833558435585355863558735588355893559035591355923559335594355953559635597355983559935600356013560235603356043560535606356073560835609356103561135612356133561435615356163561735618356193562035621356223562335624356253562635627356283562935630356313563235633356343563535636356373563835639356403564135642356433564435645356463564735648356493565035651356523565335654356553565635657356583565935660356613566235663356643566535666356673566835669356703567135672356733567435675356763567735678356793568035681356823568335684356853568635687356883568935690356913569235693356943569535696356973569835699357003570135702357033570435705357063570735708357093571035711357123571335714357153571635717357183571935720357213572235723357243572535726357273572835729357303573135732357333573435735357363573735738357393574035741357423574335744357453574635747357483574935750357513575235753357543575535756357573575835759357603576135762357633576435765357663576735768357693577035771357723577335774357753577635777357783577935780357813578235783357843578535786357873578835789357903579135792357933579435795357963579735798357993580035801358023580335804358053580635807358083580935810358113581235813358143581535816358173581835819358203582135822358233582435825358263582735828358293583035831358323583335834358353583635837358383583935840358413584235843358443584535846358473584835849358503585135852358533585435855358563585735858358593586035861358623586335864358653586635867358683586935870358713587235873358743587535876358773587835879358803588135882358833588435885358863588735888358893589035891358923589335894358953589635897358983589935900359013590235903359043590535906359073590835909359103591135912359133591435915359163591735918359193592035921359223592335924359253592635927359283592935930359313593235933359343593535936359373593835939359403594135942359433594435945359463594735948359493595035951359523595335954359553595635957359583595935960359613596235963359643596535966359673596835969359703597135972359733597435975359763597735978359793598035981359823598335984359853598635987359883598935990359913599235993359943599535996359973599835999360003600136002360033600436005360063600736008360093601036011360123601336014360153601636017360183601936020360213602236023360243602536026360273602836029360303603136032360333603436035360363603736038360393604036041360423604336044360453604636047360483604936050360513605236053360543605536056360573605836059360603606136062360633606436065360663606736068360693607036071360723607336074360753607636077360783607936080360813608236083360843608536086360873608836089360903609136092360933609436095360963609736098360993610036101361023610336104361053610636107361083610936110361113611236113361143611536116361173611836119361203612136122361233612436125361263612736128361293613036131361323613336134361353613636137361383613936140361413614236143361443614536146361473614836149361503615136152361533615436155361563615736158361593616036161361623616336164361653616636167361683616936170361713617236173361743617536176361773617836179361803618136182361833618436185361863618736188361893619036191361923619336194361953619636197361983619936200362013620236203362043620536206362073620836209362103621136212362133621436215362163621736218362193622036221362223622336224362253622636227362283622936230362313623236233362343623536236362373623836239362403624136242362433624436245362463624736248362493625036251362523625336254362553625636257362583625936260362613626236263362643626536266362673626836269362703627136272362733627436275362763627736278362793628036281362823628336284362853628636287362883628936290362913629236293362943629536296362973629836299363003630136302363033630436305363063630736308363093631036311363123631336314363153631636317363183631936320363213632236323363243632536326363273632836329363303633136332363333633436335363363633736338363393634036341363423634336344363453634636347363483634936350363513635236353363543635536356363573635836359363603636136362363633636436365363663636736368363693637036371363723637336374363753637636377363783637936380363813638236383363843638536386363873638836389363903639136392363933639436395363963639736398363993640036401364023640336404364053640636407364083640936410364113641236413364143641536416364173641836419364203642136422364233642436425364263642736428364293643036431364323643336434364353643636437364383643936440364413644236443364443644536446364473644836449364503645136452364533645436455364563645736458364593646036461364623646336464364653646636467364683646936470364713647236473364743647536476364773647836479364803648136482364833648436485364863648736488364893649036491364923649336494364953649636497364983649936500365013650236503365043650536506365073650836509365103651136512365133651436515365163651736518365193652036521365223652336524365253652636527365283652936530365313653236533365343653536536365373653836539365403654136542365433654436545365463654736548365493655036551365523655336554365553655636557365583655936560365613656236563365643656536566365673656836569365703657136572365733657436575365763657736578365793658036581365823658336584365853658636587365883658936590365913659236593365943659536596365973659836599366003660136602366033660436605366063660736608366093661036611366123661336614366153661636617366183661936620366213662236623366243662536626366273662836629366303663136632366333663436635366363663736638366393664036641366423664336644366453664636647366483664936650366513665236653366543665536656366573665836659366603666136662366633666436665366663666736668366693667036671366723667336674366753667636677366783667936680366813668236683366843668536686366873668836689366903669136692366933669436695366963669736698366993670036701367023670336704367053670636707367083670936710367113671236713367143671536716367173671836719367203672136722367233672436725367263672736728367293673036731367323673336734367353673636737367383673936740367413674236743367443674536746367473674836749367503675136752367533675436755367563675736758367593676036761367623676336764367653676636767367683676936770367713677236773367743677536776367773677836779367803678136782367833678436785367863678736788367893679036791367923679336794367953679636797367983679936800368013680236803368043680536806368073680836809368103681136812368133681436815368163681736818368193682036821368223682336824368253682636827368283682936830368313683236833368343683536836368373683836839368403684136842368433684436845368463684736848368493685036851368523685336854368553685636857368583685936860368613686236863368643686536866368673686836869368703687136872368733687436875368763687736878368793688036881368823688336884368853688636887368883688936890368913689236893368943689536896368973689836899369003690136902369033690436905369063690736908369093691036911369123691336914369153691636917369183691936920369213692236923369243692536926369273692836929369303693136932369333693436935369363693736938369393694036941369423694336944369453694636947369483694936950369513695236953369543695536956369573695836959369603696136962369633696436965369663696736968369693697036971369723697336974369753697636977369783697936980369813698236983369843698536986369873698836989369903699136992369933699436995369963699736998369993700037001370023700337004370053700637007370083700937010370113701237013370143701537016370173701837019370203702137022370233702437025370263702737028370293703037031370323703337034370353703637037370383703937040370413704237043370443704537046370473704837049370503705137052370533705437055370563705737058370593706037061370623706337064370653706637067370683706937070370713707237073370743707537076370773707837079370803708137082370833708437085370863708737088370893709037091370923709337094370953709637097370983709937100371013710237103371043710537106371073710837109371103711137112371133711437115371163711737118371193712037121371223712337124371253712637127371283712937130371313713237133371343713537136371373713837139371403714137142371433714437145371463714737148371493715037151371523715337154371553715637157371583715937160371613716237163371643716537166371673716837169371703717137172371733717437175371763717737178371793718037181371823718337184371853718637187371883718937190371913719237193371943719537196371973719837199372003720137202372033720437205372063720737208372093721037211372123721337214372153721637217372183721937220372213722237223372243722537226372273722837229372303723137232372333723437235372363723737238372393724037241372423724337244372453724637247372483724937250372513725237253372543725537256372573725837259372603726137262372633726437265372663726737268372693727037271372723727337274372753727637277372783727937280372813728237283372843728537286372873728837289372903729137292372933729437295372963729737298372993730037301373023730337304373053730637307373083730937310373113731237313373143731537316373173731837319373203732137322373233732437325373263732737328373293733037331373323733337334373353733637337373383733937340373413734237343373443734537346373473734837349373503735137352373533735437355373563735737358373593736037361373623736337364373653736637367373683736937370373713737237373373743737537376373773737837379373803738137382373833738437385373863738737388373893739037391373923739337394373953739637397373983739937400374013740237403374043740537406374073740837409374103741137412374133741437415374163741737418374193742037421374223742337424374253742637427374283742937430374313743237433374343743537436374373743837439374403744137442374433744437445374463744737448374493745037451374523745337454374553745637457374583745937460374613746237463374643746537466374673746837469374703747137472374733747437475374763747737478374793748037481374823748337484374853748637487374883748937490374913749237493374943749537496374973749837499375003750137502375033750437505375063750737508375093751037511375123751337514375153751637517375183751937520375213752237523375243752537526375273752837529375303753137532375333753437535375363753737538375393754037541375423754337544375453754637547375483754937550375513755237553375543755537556375573755837559375603756137562375633756437565375663756737568375693757037571375723757337574375753757637577375783757937580375813758237583375843758537586375873758837589375903759137592375933759437595375963759737598375993760037601376023760337604376053760637607376083760937610376113761237613376143761537616376173761837619376203762137622376233762437625376263762737628376293763037631376323763337634376353763637637376383763937640376413764237643376443764537646376473764837649376503765137652376533765437655376563765737658376593766037661376623766337664376653766637667376683766937670376713767237673376743767537676376773767837679376803768137682376833768437685376863768737688376893769037691376923769337694376953769637697376983769937700377013770237703377043770537706377073770837709377103771137712377133771437715377163771737718377193772037721377223772337724377253772637727377283772937730377313773237733377343773537736377373773837739377403774137742377433774437745377463774737748377493775037751377523775337754377553775637757377583775937760377613776237763377643776537766377673776837769377703777137772377733777437775377763777737778377793778037781377823778337784377853778637787377883778937790377913779237793377943779537796377973779837799378003780137802378033780437805378063780737808378093781037811378123781337814378153781637817378183781937820378213782237823378243782537826378273782837829378303783137832378333783437835378363783737838378393784037841378423784337844378453784637847378483784937850378513785237853378543785537856378573785837859378603786137862378633786437865378663786737868378693787037871378723787337874378753787637877378783787937880378813788237883378843788537886378873788837889378903789137892378933789437895378963789737898378993790037901379023790337904379053790637907379083790937910379113791237913379143791537916379173791837919379203792137922379233792437925379263792737928379293793037931379323793337934379353793637937379383793937940379413794237943379443794537946379473794837949379503795137952379533795437955379563795737958379593796037961379623796337964379653796637967379683796937970379713797237973379743797537976379773797837979379803798137982379833798437985379863798737988379893799037991379923799337994379953799637997379983799938000380013800238003380043800538006380073800838009380103801138012380133801438015380163801738018380193802038021380223802338024380253802638027380283802938030380313803238033380343803538036380373803838039380403804138042380433804438045380463804738048380493805038051380523805338054380553805638057380583805938060380613806238063380643806538066380673806838069380703807138072380733807438075380763807738078380793808038081380823808338084380853808638087380883808938090380913809238093380943809538096380973809838099381003810138102381033810438105381063810738108381093811038111381123811338114381153811638117381183811938120381213812238123381243812538126381273812838129381303813138132381333813438135381363813738138381393814038141381423814338144381453814638147381483814938150381513815238153381543815538156381573815838159381603816138162381633816438165381663816738168381693817038171381723817338174381753817638177381783817938180381813818238183381843818538186381873818838189381903819138192381933819438195381963819738198381993820038201382023820338204382053820638207382083820938210382113821238213382143821538216382173821838219382203822138222382233822438225382263822738228382293823038231382323823338234382353823638237382383823938240382413824238243382443824538246382473824838249382503825138252382533825438255382563825738258382593826038261382623826338264382653826638267382683826938270382713827238273382743827538276382773827838279382803828138282382833828438285382863828738288382893829038291382923829338294382953829638297382983829938300383013830238303383043830538306383073830838309383103831138312383133831438315383163831738318383193832038321383223832338324383253832638327383283832938330383313833238333383343833538336383373833838339383403834138342383433834438345383463834738348383493835038351383523835338354383553835638357383583835938360383613836238363383643836538366383673836838369383703837138372383733837438375383763837738378383793838038381383823838338384383853838638387383883838938390383913839238393383943839538396383973839838399384003840138402384033840438405384063840738408384093841038411384123841338414384153841638417384183841938420384213842238423384243842538426384273842838429384303843138432384333843438435384363843738438384393844038441384423844338444384453844638447384483844938450384513845238453384543845538456384573845838459384603846138462384633846438465384663846738468384693847038471384723847338474384753847638477384783847938480384813848238483384843848538486384873848838489384903849138492384933849438495384963849738498384993850038501385023850338504385053850638507385083850938510385113851238513385143851538516385173851838519385203852138522385233852438525385263852738528385293853038531385323853338534385353853638537385383853938540385413854238543385443854538546385473854838549385503855138552385533855438555385563855738558385593856038561385623856338564385653856638567385683856938570385713857238573385743857538576385773857838579385803858138582385833858438585385863858738588385893859038591385923859338594385953859638597385983859938600386013860238603386043860538606386073860838609386103861138612386133861438615386163861738618386193862038621386223862338624386253862638627386283862938630386313863238633386343863538636386373863838639386403864138642386433864438645386463864738648386493865038651386523865338654386553865638657386583865938660386613866238663386643866538666386673866838669386703867138672386733867438675386763867738678386793868038681386823868338684386853868638687386883868938690386913869238693386943869538696386973869838699387003870138702387033870438705387063870738708387093871038711387123871338714387153871638717387183871938720387213872238723387243872538726387273872838729387303873138732387333873438735387363873738738387393874038741387423874338744387453874638747387483874938750387513875238753387543875538756387573875838759387603876138762387633876438765387663876738768387693877038771387723877338774387753877638777387783877938780387813878238783387843878538786387873878838789387903879138792387933879438795387963879738798387993880038801388023880338804388053880638807388083880938810388113881238813388143881538816388173881838819388203882138822388233882438825388263882738828388293883038831388323883338834388353883638837388383883938840388413884238843388443884538846388473884838849388503885138852388533885438855388563885738858388593886038861388623886338864388653886638867388683886938870388713887238873388743887538876388773887838879388803888138882388833888438885388863888738888388893889038891388923889338894388953889638897388983889938900389013890238903389043890538906389073890838909389103891138912389133891438915389163891738918389193892038921389223892338924389253892638927389283892938930389313893238933389343893538936389373893838939389403894138942389433894438945389463894738948389493895038951389523895338954389553895638957389583895938960389613896238963389643896538966389673896838969389703897138972389733897438975389763897738978389793898038981389823898338984389853898638987389883898938990389913899238993389943899538996389973899838999390003900139002390033900439005390063900739008390093901039011390123901339014390153901639017390183901939020390213902239023390243902539026390273902839029390303903139032390333903439035390363903739038390393904039041390423904339044390453904639047390483904939050390513905239053390543905539056390573905839059390603906139062390633906439065390663906739068390693907039071390723907339074390753907639077390783907939080390813908239083390843908539086390873908839089390903909139092390933909439095390963909739098390993910039101391023910339104391053910639107391083910939110391113911239113391143911539116391173911839119391203912139122391233912439125391263912739128391293913039131391323913339134391353913639137391383913939140391413914239143391443914539146391473914839149391503915139152391533915439155391563915739158391593916039161391623916339164391653916639167391683916939170391713917239173391743917539176391773917839179391803918139182391833918439185391863918739188391893919039191391923919339194391953919639197391983919939200392013920239203392043920539206392073920839209392103921139212392133921439215392163921739218392193922039221392223922339224392253922639227392283922939230392313923239233392343923539236392373923839239392403924139242392433924439245392463924739248392493925039251392523925339254392553925639257392583925939260392613926239263392643926539266392673926839269392703927139272392733927439275392763927739278392793928039281392823928339284392853928639287392883928939290392913929239293392943929539296392973929839299393003930139302393033930439305393063930739308393093931039311393123931339314393153931639317393183931939320393213932239323393243932539326393273932839329393303933139332393333933439335393363933739338393393934039341393423934339344393453934639347393483934939350393513935239353393543935539356393573935839359393603936139362393633936439365393663936739368393693937039371393723937339374393753937639377393783937939380393813938239383393843938539386393873938839389393903939139392393933939439395393963939739398393993940039401394023940339404394053940639407394083940939410394113941239413394143941539416394173941839419394203942139422394233942439425394263942739428394293943039431394323943339434394353943639437394383943939440394413944239443394443944539446394473944839449394503945139452394533945439455394563945739458394593946039461394623946339464394653946639467394683946939470394713947239473394743947539476394773947839479394803948139482394833948439485394863948739488394893949039491394923949339494394953949639497394983949939500395013950239503395043950539506395073950839509395103951139512395133951439515395163951739518395193952039521395223952339524395253952639527395283952939530395313953239533395343953539536395373953839539395403954139542395433954439545395463954739548395493955039551395523955339554395553955639557395583955939560395613956239563395643956539566395673956839569395703957139572395733957439575395763957739578395793958039581395823958339584395853958639587395883958939590395913959239593395943959539596395973959839599396003960139602396033960439605396063960739608396093961039611396123961339614396153961639617396183961939620396213962239623396243962539626396273962839629396303963139632396333963439635396363963739638396393964039641396423964339644396453964639647396483964939650396513965239653396543965539656396573965839659396603966139662396633966439665396663966739668396693967039671396723967339674396753967639677396783967939680396813968239683396843968539686396873968839689396903969139692396933969439695396963969739698396993970039701397023970339704397053970639707397083970939710397113971239713397143971539716397173971839719397203972139722397233972439725397263972739728397293973039731397323973339734397353973639737397383973939740397413974239743397443974539746397473974839749397503975139752397533975439755397563975739758397593976039761397623976339764397653976639767397683976939770397713977239773397743977539776397773977839779397803978139782397833978439785397863978739788397893979039791397923979339794397953979639797397983979939800398013980239803398043980539806398073980839809398103981139812398133981439815398163981739818398193982039821398223982339824398253982639827398283982939830398313983239833398343983539836398373983839839398403984139842398433984439845398463984739848398493985039851398523985339854398553985639857398583985939860398613986239863398643986539866398673986839869398703987139872398733987439875398763987739878398793988039881398823988339884398853988639887398883988939890398913989239893398943989539896398973989839899399003990139902399033990439905399063990739908399093991039911399123991339914399153991639917399183991939920399213992239923399243992539926399273992839929399303993139932399333993439935399363993739938399393994039941399423994339944399453994639947399483994939950399513995239953399543995539956399573995839959399603996139962399633996439965399663996739968399693997039971399723997339974399753997639977399783997939980399813998239983399843998539986399873998839989399903999139992399933999439995399963999739998399994000040001400024000340004400054000640007400084000940010400114001240013400144001540016400174001840019400204002140022400234002440025400264002740028400294003040031400324003340034400354003640037400384003940040400414004240043400444004540046400474004840049400504005140052400534005440055400564005740058400594006040061400624006340064400654006640067400684006940070400714007240073400744007540076400774007840079400804008140082400834008440085400864008740088400894009040091400924009340094400954009640097400984009940100401014010240103401044010540106401074010840109401104011140112401134011440115401164011740118401194012040121401224012340124401254012640127401284012940130401314013240133401344013540136401374013840139401404014140142401434014440145401464014740148401494015040151401524015340154401554015640157401584015940160401614016240163401644016540166401674016840169401704017140172401734017440175401764017740178401794018040181401824018340184401854018640187401884018940190401914019240193401944019540196401974019840199402004020140202402034020440205402064020740208402094021040211402124021340214402154021640217402184021940220402214022240223402244022540226402274022840229402304023140232402334023440235402364023740238402394024040241402424024340244402454024640247402484024940250402514025240253402544025540256402574025840259402604026140262402634026440265402664026740268402694027040271402724027340274402754027640277402784027940280402814028240283402844028540286402874028840289402904029140292402934029440295402964029740298402994030040301403024030340304403054030640307403084030940310403114031240313403144031540316403174031840319403204032140322403234032440325403264032740328403294033040331403324033340334403354033640337403384033940340403414034240343403444034540346403474034840349403504035140352403534035440355403564035740358403594036040361403624036340364403654036640367403684036940370403714037240373403744037540376403774037840379403804038140382403834038440385403864038740388403894039040391403924039340394403954039640397403984039940400404014040240403404044040540406404074040840409404104041140412404134041440415404164041740418404194042040421404224042340424404254042640427404284042940430404314043240433404344043540436404374043840439404404044140442404434044440445404464044740448404494045040451404524045340454404554045640457404584045940460404614046240463404644046540466404674046840469404704047140472404734047440475404764047740478404794048040481404824048340484404854048640487404884048940490404914049240493404944049540496404974049840499405004050140502405034050440505405064050740508405094051040511405124051340514405154051640517405184051940520405214052240523405244052540526405274052840529405304053140532405334053440535405364053740538405394054040541405424054340544405454054640547405484054940550405514055240553405544055540556405574055840559405604056140562405634056440565405664056740568405694057040571405724057340574405754057640577405784057940580405814058240583405844058540586405874058840589405904059140592405934059440595405964059740598405994060040601406024060340604406054060640607406084060940610406114061240613406144061540616406174061840619406204062140622406234062440625406264062740628406294063040631406324063340634406354063640637406384063940640406414064240643406444064540646406474064840649406504065140652406534065440655406564065740658406594066040661406624066340664406654066640667406684066940670406714067240673406744067540676406774067840679406804068140682406834068440685406864068740688406894069040691406924069340694406954069640697406984069940700407014070240703407044070540706407074070840709407104071140712407134071440715407164071740718407194072040721407224072340724407254072640727407284072940730407314073240733407344073540736407374073840739407404074140742407434074440745407464074740748407494075040751407524075340754407554075640757407584075940760407614076240763407644076540766407674076840769407704077140772407734077440775407764077740778407794078040781407824078340784407854078640787407884078940790407914079240793407944079540796407974079840799408004080140802408034080440805408064080740808408094081040811408124081340814408154081640817408184081940820408214082240823408244082540826408274082840829408304083140832408334083440835408364083740838408394084040841408424084340844408454084640847408484084940850408514085240853408544085540856408574085840859408604086140862408634086440865408664086740868408694087040871408724087340874408754087640877408784087940880408814088240883408844088540886408874088840889408904089140892408934089440895408964089740898408994090040901409024090340904409054090640907409084090940910409114091240913409144091540916409174091840919409204092140922409234092440925409264092740928409294093040931409324093340934409354093640937409384093940940409414094240943409444094540946409474094840949409504095140952409534095440955409564095740958409594096040961409624096340964409654096640967409684096940970409714097240973409744097540976409774097840979409804098140982409834098440985409864098740988409894099040991409924099340994409954099640997409984099941000410014100241003410044100541006410074100841009410104101141012410134101441015410164101741018410194102041021410224102341024410254102641027410284102941030410314103241033410344103541036410374103841039410404104141042410434104441045410464104741048410494105041051410524105341054410554105641057410584105941060410614106241063410644106541066410674106841069410704107141072410734107441075410764107741078410794108041081410824108341084410854108641087410884108941090410914109241093410944109541096410974109841099411004110141102411034110441105411064110741108411094111041111411124111341114411154111641117411184111941120411214112241123411244112541126411274112841129411304113141132411334113441135411364113741138411394114041141411424114341144411454114641147411484114941150411514115241153411544115541156411574115841159411604116141162411634116441165411664116741168411694117041171411724117341174411754117641177411784117941180411814118241183411844118541186411874118841189411904119141192411934119441195411964119741198411994120041201412024120341204412054120641207412084120941210412114121241213412144121541216412174121841219412204122141222412234122441225412264122741228412294123041231412324123341234412354123641237412384123941240412414124241243412444124541246412474124841249412504125141252412534125441255412564125741258412594126041261412624126341264412654126641267412684126941270412714127241273412744127541276412774127841279412804128141282412834128441285412864128741288412894129041291412924129341294412954129641297412984129941300413014130241303413044130541306413074130841309413104131141312413134131441315413164131741318413194132041321413224132341324413254132641327413284132941330413314133241333413344133541336413374133841339413404134141342413434134441345413464134741348413494135041351413524135341354413554135641357413584135941360413614136241363413644136541366413674136841369413704137141372413734137441375413764137741378413794138041381413824138341384413854138641387413884138941390413914139241393413944139541396413974139841399414004140141402414034140441405414064140741408414094141041411414124141341414414154141641417414184141941420414214142241423414244142541426414274142841429414304143141432414334143441435414364143741438414394144041441414424144341444414454144641447414484144941450414514145241453414544145541456414574145841459414604146141462414634146441465414664146741468414694147041471414724147341474414754147641477414784147941480414814148241483414844148541486414874148841489414904149141492414934149441495414964149741498414994150041501415024150341504415054150641507415084150941510415114151241513415144151541516415174151841519415204152141522415234152441525415264152741528415294153041531415324153341534415354153641537415384153941540415414154241543415444154541546415474154841549415504155141552415534155441555415564155741558415594156041561415624156341564415654156641567415684156941570415714157241573415744157541576415774157841579415804158141582415834158441585415864158741588415894159041591415924159341594415954159641597415984159941600416014160241603416044160541606416074160841609416104161141612416134161441615416164161741618416194162041621416224162341624416254162641627416284162941630416314163241633416344163541636416374163841639416404164141642416434164441645416464164741648416494165041651416524165341654416554165641657416584165941660416614166241663416644166541666416674166841669416704167141672416734167441675416764167741678416794168041681416824168341684416854168641687416884168941690416914169241693416944169541696416974169841699417004170141702417034170441705417064170741708417094171041711417124171341714417154171641717417184171941720417214172241723417244172541726417274172841729417304173141732417334173441735417364173741738417394174041741417424174341744417454174641747417484174941750417514175241753417544175541756417574175841759417604176141762417634176441765417664176741768417694177041771417724177341774417754177641777417784177941780417814178241783417844178541786417874178841789417904179141792417934179441795417964179741798417994180041801418024180341804418054180641807418084180941810418114181241813418144181541816418174181841819418204182141822418234182441825418264182741828418294183041831418324183341834418354183641837418384183941840418414184241843418444184541846418474184841849418504185141852418534185441855418564185741858418594186041861418624186341864418654186641867418684186941870418714187241873418744187541876418774187841879418804188141882418834188441885418864188741888418894189041891418924189341894418954189641897418984189941900419014190241903419044190541906419074190841909419104191141912419134191441915419164191741918419194192041921419224192341924419254192641927419284192941930419314193241933419344193541936419374193841939419404194141942419434194441945419464194741948419494195041951419524195341954419554195641957419584195941960419614196241963419644196541966419674196841969419704197141972419734197441975419764197741978419794198041981419824198341984419854198641987419884198941990419914199241993419944199541996419974199841999420004200142002420034200442005420064200742008420094201042011420124201342014420154201642017420184201942020420214202242023420244202542026420274202842029420304203142032420334203442035420364203742038420394204042041420424204342044420454204642047420484204942050420514205242053420544205542056420574205842059420604206142062420634206442065420664206742068420694207042071420724207342074420754207642077420784207942080420814208242083420844208542086420874208842089420904209142092420934209442095420964209742098420994210042101421024210342104421054210642107421084210942110421114211242113421144211542116421174211842119421204212142122421234212442125421264212742128421294213042131421324213342134421354213642137421384213942140421414214242143421444214542146421474214842149421504215142152421534215442155421564215742158421594216042161421624216342164421654216642167421684216942170421714217242173421744217542176421774217842179421804218142182421834218442185421864218742188421894219042191421924219342194421954219642197421984219942200422014220242203422044220542206422074220842209422104221142212422134221442215422164221742218422194222042221422224222342224422254222642227422284222942230422314223242233422344223542236422374223842239422404224142242422434224442245422464224742248422494225042251422524225342254422554225642257422584225942260422614226242263422644226542266422674226842269422704227142272422734227442275422764227742278422794228042281422824228342284422854228642287422884228942290422914229242293422944229542296422974229842299423004230142302423034230442305423064230742308423094231042311423124231342314423154231642317423184231942320423214232242323423244232542326423274232842329423304233142332423334233442335423364233742338423394234042341423424234342344423454234642347423484234942350423514235242353423544235542356423574235842359423604236142362423634236442365423664236742368423694237042371423724237342374423754237642377423784237942380423814238242383423844238542386423874238842389423904239142392423934239442395423964239742398423994240042401424024240342404424054240642407424084240942410424114241242413424144241542416424174241842419424204242142422424234242442425424264242742428424294243042431424324243342434424354243642437424384243942440424414244242443424444244542446424474244842449424504245142452424534245442455424564245742458424594246042461424624246342464424654246642467424684246942470424714247242473424744247542476424774247842479424804248142482424834248442485424864248742488424894249042491424924249342494424954249642497424984249942500425014250242503425044250542506425074250842509425104251142512425134251442515425164251742518425194252042521425224252342524425254252642527425284252942530425314253242533425344253542536425374253842539425404254142542425434254442545425464254742548425494255042551425524255342554425554255642557425584255942560425614256242563425644256542566425674256842569425704257142572425734257442575425764257742578425794258042581425824258342584425854258642587425884258942590425914259242593425944259542596425974259842599426004260142602426034260442605426064260742608426094261042611426124261342614426154261642617426184261942620426214262242623426244262542626426274262842629426304263142632426334263442635426364263742638426394264042641426424264342644426454264642647426484264942650426514265242653426544265542656426574265842659426604266142662426634266442665426664266742668426694267042671426724267342674426754267642677426784267942680426814268242683426844268542686426874268842689426904269142692426934269442695426964269742698426994270042701427024270342704427054270642707427084270942710427114271242713427144271542716427174271842719427204272142722427234272442725427264272742728427294273042731427324273342734427354273642737427384273942740427414274242743427444274542746427474274842749427504275142752427534275442755427564275742758427594276042761427624276342764427654276642767427684276942770427714277242773427744277542776427774277842779427804278142782427834278442785427864278742788427894279042791427924279342794427954279642797427984279942800428014280242803428044280542806428074280842809428104281142812428134281442815428164281742818428194282042821428224282342824428254282642827428284282942830428314283242833428344283542836428374283842839428404284142842428434284442845428464284742848428494285042851428524285342854428554285642857428584285942860428614286242863428644286542866428674286842869428704287142872428734287442875428764287742878428794288042881428824288342884428854288642887428884288942890428914289242893428944289542896428974289842899429004290142902429034290442905429064290742908429094291042911429124291342914429154291642917429184291942920429214292242923429244292542926429274292842929429304293142932429334293442935429364293742938429394294042941429424294342944429454294642947429484294942950429514295242953429544295542956429574295842959429604296142962429634296442965429664296742968429694297042971429724297342974429754297642977429784297942980429814298242983429844298542986429874298842989429904299142992429934299442995429964299742998429994300043001430024300343004430054300643007430084300943010430114301243013430144301543016430174301843019430204302143022430234302443025430264302743028430294303043031430324303343034430354303643037430384303943040430414304243043430444304543046430474304843049430504305143052430534305443055430564305743058430594306043061430624306343064430654306643067430684306943070430714307243073430744307543076430774307843079430804308143082430834308443085430864308743088430894309043091430924309343094430954309643097430984309943100431014310243103431044310543106431074310843109431104311143112431134311443115431164311743118431194312043121431224312343124431254312643127431284312943130431314313243133431344313543136431374313843139431404314143142431434314443145431464314743148431494315043151431524315343154431554315643157431584315943160431614316243163431644316543166431674316843169431704317143172431734317443175431764317743178431794318043181431824318343184431854318643187431884318943190431914319243193431944319543196431974319843199432004320143202432034320443205432064320743208432094321043211432124321343214432154321643217432184321943220432214322243223432244322543226432274322843229432304323143232432334323443235432364323743238432394324043241432424324343244432454324643247432484324943250432514325243253432544325543256432574325843259432604326143262432634326443265432664326743268432694327043271432724327343274432754327643277432784327943280432814328243283432844328543286432874328843289432904329143292432934329443295432964329743298432994330043301433024330343304433054330643307433084330943310433114331243313433144331543316433174331843319433204332143322433234332443325433264332743328433294333043331433324333343334433354333643337433384333943340433414334243343433444334543346433474334843349433504335143352433534335443355433564335743358433594336043361433624336343364433654336643367433684336943370433714337243373433744337543376433774337843379433804338143382433834338443385433864338743388433894339043391433924339343394433954339643397433984339943400434014340243403434044340543406434074340843409434104341143412434134341443415434164341743418434194342043421434224342343424434254342643427434284342943430434314343243433434344343543436434374343843439434404344143442434434344443445434464344743448434494345043451434524345343454434554345643457434584345943460434614346243463434644346543466434674346843469434704347143472434734347443475434764347743478434794348043481434824348343484434854348643487434884348943490434914349243493434944349543496434974349843499435004350143502435034350443505435064350743508435094351043511435124351343514435154351643517435184351943520435214352243523435244352543526435274352843529435304353143532435334353443535435364353743538435394354043541435424354343544435454354643547435484354943550435514355243553435544355543556435574355843559435604356143562435634356443565435664356743568435694357043571435724357343574435754357643577435784357943580435814358243583435844358543586435874358843589435904359143592435934359443595435964359743598435994360043601436024360343604436054360643607436084360943610436114361243613436144361543616436174361843619436204362143622436234362443625436264362743628436294363043631436324363343634436354363643637436384363943640436414364243643436444364543646436474364843649436504365143652436534365443655436564365743658436594366043661436624366343664436654366643667436684366943670436714367243673436744367543676436774367843679436804368143682436834368443685436864368743688436894369043691436924369343694436954369643697436984369943700437014370243703437044370543706437074370843709437104371143712437134371443715437164371743718437194372043721437224372343724437254372643727437284372943730437314373243733437344373543736437374373843739437404374143742437434374443745437464374743748437494375043751437524375343754437554375643757437584375943760437614376243763437644376543766437674376843769437704377143772437734377443775437764377743778437794378043781437824378343784437854378643787437884378943790437914379243793437944379543796437974379843799438004380143802438034380443805438064380743808438094381043811438124381343814438154381643817438184381943820438214382243823438244382543826438274382843829438304383143832438334383443835438364383743838438394384043841438424384343844438454384643847438484384943850438514385243853438544385543856438574385843859438604386143862438634386443865438664386743868438694387043871438724387343874438754387643877438784387943880438814388243883438844388543886438874388843889438904389143892438934389443895438964389743898438994390043901439024390343904439054390643907439084390943910439114391243913439144391543916439174391843919439204392143922439234392443925439264392743928439294393043931439324393343934439354393643937439384393943940439414394243943439444394543946439474394843949439504395143952439534395443955439564395743958439594396043961439624396343964439654396643967439684396943970439714397243973439744397543976439774397843979439804398143982439834398443985439864398743988439894399043991439924399343994439954399643997439984399944000440014400244003440044400544006440074400844009440104401144012440134401444015440164401744018440194402044021440224402344024440254402644027440284402944030440314403244033440344403544036440374403844039440404404144042440434404444045440464404744048440494405044051440524405344054440554405644057440584405944060440614406244063440644406544066440674406844069440704407144072440734407444075440764407744078440794408044081440824408344084440854408644087440884408944090440914409244093440944409544096440974409844099441004410144102441034410444105441064410744108441094411044111441124411344114441154411644117441184411944120441214412244123441244412544126441274412844129441304413144132441334413444135441364413744138441394414044141441424414344144441454414644147441484414944150441514415244153441544415544156441574415844159441604416144162441634416444165441664416744168441694417044171441724417344174441754417644177441784417944180441814418244183441844418544186441874418844189441904419144192441934419444195441964419744198441994420044201442024420344204442054420644207442084420944210442114421244213442144421544216442174421844219442204422144222442234422444225442264422744228442294423044231442324423344234442354423644237442384423944240442414424244243442444424544246442474424844249442504425144252442534425444255442564425744258442594426044261442624426344264442654426644267442684426944270442714427244273442744427544276442774427844279442804428144282442834428444285442864428744288442894429044291442924429344294442954429644297442984429944300443014430244303443044430544306443074430844309443104431144312443134431444315443164431744318443194432044321443224432344324443254432644327443284432944330443314433244333443344433544336443374433844339443404434144342443434434444345443464434744348443494435044351443524435344354443554435644357443584435944360443614436244363443644436544366443674436844369443704437144372443734437444375443764437744378443794438044381443824438344384443854438644387443884438944390443914439244393443944439544396443974439844399444004440144402444034440444405444064440744408444094441044411444124441344414444154441644417444184441944420444214442244423444244442544426444274442844429444304443144432444334443444435444364443744438444394444044441444424444344444444454444644447444484444944450444514445244453444544445544456444574445844459444604446144462444634446444465444664446744468444694447044471444724447344474444754447644477444784447944480444814448244483444844448544486444874448844489444904449144492444934449444495444964449744498444994450044501445024450344504445054450644507445084450944510445114451244513445144451544516445174451844519445204452144522445234452444525445264452744528445294453044531445324453344534445354453644537445384453944540445414454244543445444454544546445474454844549445504455144552445534455444555445564455744558445594456044561445624456344564445654456644567445684456944570445714457244573445744457544576445774457844579445804458144582445834458444585445864458744588445894459044591445924459344594445954459644597445984459944600446014460244603446044460544606446074460844609446104461144612446134461444615446164461744618446194462044621446224462344624446254462644627446284462944630446314463244633446344463544636446374463844639446404464144642446434464444645446464464744648446494465044651446524465344654446554465644657446584465944660446614466244663446644466544666446674466844669446704467144672446734467444675446764467744678446794468044681446824468344684446854468644687446884468944690446914469244693446944469544696446974469844699447004470144702447034470444705447064470744708447094471044711447124471344714447154471644717447184471944720447214472244723447244472544726447274472844729447304473144732447334473444735447364473744738447394474044741447424474344744447454474644747447484474944750447514475244753447544475544756447574475844759447604476144762447634476444765447664476744768447694477044771447724477344774447754477644777447784477944780447814478244783447844478544786447874478844789447904479144792447934479444795447964479744798447994480044801448024480344804448054480644807448084480944810448114481244813448144481544816448174481844819448204482144822448234482444825448264482744828448294483044831448324483344834448354483644837448384483944840448414484244843448444484544846448474484844849448504485144852448534485444855448564485744858448594486044861448624486344864448654486644867448684486944870448714487244873448744487544876448774487844879448804488144882448834488444885448864488744888448894489044891448924489344894448954489644897448984489944900449014490244903449044490544906449074490844909449104491144912449134491444915449164491744918449194492044921449224492344924449254492644927449284492944930449314493244933449344493544936449374493844939449404494144942449434494444945449464494744948449494495044951449524495344954449554495644957449584495944960449614496244963449644496544966449674496844969449704497144972449734497444975449764497744978449794498044981449824498344984449854498644987449884498944990449914499244993449944499544996449974499844999450004500145002450034500445005450064500745008450094501045011450124501345014450154501645017450184501945020450214502245023450244502545026450274502845029450304503145032450334503445035450364503745038450394504045041450424504345044450454504645047450484504945050450514505245053450544505545056450574505845059450604506145062450634506445065450664506745068450694507045071450724507345074450754507645077450784507945080450814508245083450844508545086450874508845089450904509145092450934509445095450964509745098450994510045101451024510345104451054510645107451084510945110451114511245113451144511545116451174511845119451204512145122451234512445125451264512745128451294513045131451324513345134451354513645137451384513945140451414514245143451444514545146451474514845149451504515145152451534515445155451564515745158451594516045161451624516345164451654516645167451684516945170451714517245173451744517545176451774517845179451804518145182451834518445185451864518745188451894519045191451924519345194451954519645197451984519945200452014520245203452044520545206452074520845209452104521145212452134521445215452164521745218452194522045221452224522345224452254522645227452284522945230452314523245233452344523545236452374523845239452404524145242452434524445245452464524745248452494525045251452524525345254452554525645257452584525945260452614526245263452644526545266452674526845269452704527145272452734527445275452764527745278452794528045281452824528345284452854528645287452884528945290452914529245293452944529545296452974529845299453004530145302453034530445305453064530745308453094531045311453124531345314453154531645317453184531945320453214532245323453244532545326453274532845329453304533145332453334533445335453364533745338453394534045341453424534345344453454534645347453484534945350453514535245353453544535545356453574535845359453604536145362453634536445365453664536745368453694537045371453724537345374453754537645377453784537945380453814538245383453844538545386453874538845389453904539145392453934539445395453964539745398453994540045401454024540345404454054540645407454084540945410454114541245413454144541545416454174541845419454204542145422454234542445425454264542745428454294543045431454324543345434454354543645437454384543945440454414544245443454444544545446454474544845449454504545145452454534545445455454564545745458454594546045461454624546345464454654546645467454684546945470454714547245473454744547545476454774547845479454804548145482454834548445485454864548745488454894549045491454924549345494454954549645497454984549945500455014550245503455044550545506455074550845509455104551145512455134551445515455164551745518455194552045521455224552345524455254552645527455284552945530455314553245533455344553545536455374553845539455404554145542455434554445545455464554745548455494555045551455524555345554455554555645557455584555945560455614556245563455644556545566455674556845569455704557145572455734557445575455764557745578455794558045581455824558345584455854558645587455884558945590455914559245593455944559545596455974559845599456004560145602456034560445605456064560745608456094561045611456124561345614456154561645617456184561945620456214562245623456244562545626456274562845629456304563145632456334563445635456364563745638456394564045641456424564345644456454564645647456484564945650456514565245653456544565545656456574565845659456604566145662456634566445665456664566745668456694567045671456724567345674456754567645677456784567945680456814568245683456844568545686456874568845689456904569145692456934569445695456964569745698456994570045701457024570345704457054570645707457084570945710457114571245713457144571545716457174571845719457204572145722457234572445725457264572745728457294573045731457324573345734457354573645737457384573945740457414574245743457444574545746457474574845749457504575145752457534575445755457564575745758457594576045761457624576345764457654576645767457684576945770457714577245773457744577545776457774577845779457804578145782457834578445785457864578745788457894579045791457924579345794457954579645797457984579945800458014580245803458044580545806458074580845809458104581145812458134581445815458164581745818458194582045821458224582345824458254582645827458284582945830458314583245833458344583545836458374583845839458404584145842458434584445845458464584745848458494585045851458524585345854458554585645857458584585945860458614586245863458644586545866458674586845869458704587145872458734587445875458764587745878458794588045881458824588345884458854588645887458884588945890458914589245893458944589545896458974589845899459004590145902459034590445905459064590745908459094591045911459124591345914459154591645917459184591945920459214592245923459244592545926459274592845929459304593145932459334593445935459364593745938459394594045941459424594345944459454594645947459484594945950459514595245953459544595545956459574595845959459604596145962459634596445965459664596745968459694597045971459724597345974459754597645977459784597945980459814598245983459844598545986459874598845989459904599145992459934599445995459964599745998459994600046001460024600346004460054600646007460084600946010460114601246013460144601546016460174601846019460204602146022460234602446025460264602746028460294603046031460324603346034460354603646037460384603946040460414604246043460444604546046460474604846049460504605146052460534605446055460564605746058460594606046061460624606346064460654606646067460684606946070460714607246073460744607546076460774607846079460804608146082460834608446085460864608746088460894609046091460924609346094460954609646097460984609946100461014610246103461044610546106461074610846109461104611146112461134611446115461164611746118461194612046121461224612346124461254612646127461284612946130461314613246133461344613546136461374613846139461404614146142461434614446145461464614746148461494615046151461524615346154461554615646157461584615946160461614616246163461644616546166461674616846169461704617146172461734617446175461764617746178461794618046181461824618346184461854618646187461884618946190461914619246193461944619546196461974619846199462004620146202462034620446205462064620746208462094621046211462124621346214462154621646217462184621946220462214622246223462244622546226462274622846229462304623146232462334623446235462364623746238462394624046241462424624346244462454624646247462484624946250462514625246253462544625546256462574625846259462604626146262462634626446265462664626746268462694627046271462724627346274462754627646277462784627946280462814628246283462844628546286462874628846289462904629146292462934629446295462964629746298462994630046301463024630346304463054630646307463084630946310463114631246313463144631546316463174631846319463204632146322463234632446325463264632746328463294633046331463324633346334463354633646337463384633946340463414634246343463444634546346463474634846349463504635146352463534635446355463564635746358463594636046361463624636346364463654636646367463684636946370463714637246373463744637546376463774637846379463804638146382463834638446385463864638746388463894639046391463924639346394463954639646397463984639946400464014640246403464044640546406464074640846409464104641146412464134641446415464164641746418464194642046421464224642346424464254642646427464284642946430464314643246433464344643546436464374643846439464404644146442464434644446445464464644746448464494645046451464524645346454464554645646457464584645946460464614646246463464644646546466464674646846469464704647146472464734647446475464764647746478464794648046481464824648346484464854648646487464884648946490464914649246493464944649546496464974649846499465004650146502465034650446505465064650746508465094651046511465124651346514465154651646517465184651946520465214652246523465244652546526465274652846529465304653146532465334653446535465364653746538465394654046541465424654346544465454654646547465484654946550465514655246553465544655546556465574655846559465604656146562465634656446565465664656746568465694657046571465724657346574465754657646577465784657946580465814658246583465844658546586465874658846589465904659146592465934659446595465964659746598465994660046601466024660346604466054660646607466084660946610466114661246613466144661546616466174661846619466204662146622466234662446625466264662746628466294663046631466324663346634466354663646637466384663946640466414664246643466444664546646466474664846649466504665146652466534665446655466564665746658466594666046661466624666346664466654666646667466684666946670466714667246673466744667546676466774667846679466804668146682466834668446685466864668746688466894669046691466924669346694466954669646697466984669946700467014670246703467044670546706467074670846709467104671146712467134671446715467164671746718467194672046721467224672346724467254672646727467284672946730467314673246733467344673546736467374673846739467404674146742467434674446745467464674746748467494675046751467524675346754467554675646757467584675946760467614676246763467644676546766467674676846769467704677146772467734677446775467764677746778467794678046781467824678346784467854678646787467884678946790467914679246793467944679546796467974679846799468004680146802468034680446805468064680746808468094681046811468124681346814468154681646817468184681946820468214682246823468244682546826468274682846829468304683146832468334683446835468364683746838468394684046841468424684346844468454684646847468484684946850468514685246853468544685546856468574685846859468604686146862468634686446865468664686746868468694687046871468724687346874468754687646877468784687946880468814688246883468844688546886468874688846889468904689146892468934689446895468964689746898468994690046901469024690346904469054690646907469084690946910469114691246913469144691546916469174691846919469204692146922469234692446925469264692746928469294693046931469324693346934469354693646937469384693946940469414694246943469444694546946469474694846949469504695146952469534695446955469564695746958469594696046961469624696346964469654696646967469684696946970469714697246973469744697546976469774697846979469804698146982469834698446985469864698746988469894699046991469924699346994469954699646997469984699947000470014700247003470044700547006470074700847009470104701147012470134701447015470164701747018470194702047021470224702347024470254702647027470284702947030470314703247033470344703547036470374703847039470404704147042470434704447045470464704747048470494705047051470524705347054470554705647057470584705947060470614706247063470644706547066470674706847069470704707147072470734707447075470764707747078470794708047081470824708347084470854708647087470884708947090470914709247093470944709547096470974709847099471004710147102471034710447105471064710747108471094711047111471124711347114471154711647117471184711947120471214712247123471244712547126471274712847129471304713147132471334713447135471364713747138471394714047141471424714347144471454714647147471484714947150471514715247153471544715547156471574715847159471604716147162471634716447165471664716747168471694717047171471724717347174471754717647177471784717947180471814718247183471844718547186471874718847189471904719147192471934719447195471964719747198471994720047201472024720347204472054720647207472084720947210472114721247213472144721547216472174721847219472204722147222472234722447225472264722747228472294723047231472324723347234472354723647237472384723947240472414724247243472444724547246472474724847249472504725147252472534725447255472564725747258472594726047261472624726347264472654726647267472684726947270472714727247273472744727547276472774727847279472804728147282472834728447285472864728747288472894729047291472924729347294472954729647297472984729947300473014730247303473044730547306473074730847309473104731147312473134731447315473164731747318473194732047321473224732347324473254732647327473284732947330473314733247333473344733547336473374733847339473404734147342473434734447345473464734747348473494735047351473524735347354473554735647357473584735947360473614736247363473644736547366473674736847369473704737147372473734737447375473764737747378473794738047381473824738347384473854738647387473884738947390473914739247393473944739547396473974739847399474004740147402474034740447405474064740747408474094741047411474124741347414474154741647417474184741947420474214742247423474244742547426474274742847429474304743147432474334743447435474364743747438474394744047441474424744347444474454744647447474484744947450474514745247453474544745547456474574745847459474604746147462474634746447465474664746747468474694747047471474724747347474474754747647477474784747947480474814748247483474844748547486474874748847489474904749147492474934749447495474964749747498474994750047501475024750347504475054750647507475084750947510475114751247513475144751547516475174751847519475204752147522475234752447525475264752747528475294753047531475324753347534475354753647537475384753947540475414754247543475444754547546475474754847549475504755147552475534755447555475564755747558475594756047561475624756347564475654756647567475684756947570475714757247573475744757547576475774757847579475804758147582475834758447585475864758747588475894759047591475924759347594475954759647597475984759947600476014760247603476044760547606476074760847609476104761147612476134761447615476164761747618476194762047621476224762347624476254762647627476284762947630476314763247633476344763547636476374763847639476404764147642476434764447645476464764747648476494765047651476524765347654476554765647657476584765947660476614766247663476644766547666476674766847669476704767147672476734767447675476764767747678476794768047681476824768347684476854768647687476884768947690476914769247693476944769547696476974769847699477004770147702477034770447705477064770747708477094771047711477124771347714477154771647717477184771947720477214772247723477244772547726477274772847729477304773147732477334773447735477364773747738477394774047741477424774347744477454774647747477484774947750477514775247753477544775547756477574775847759477604776147762477634776447765477664776747768477694777047771477724777347774477754777647777477784777947780477814778247783477844778547786477874778847789477904779147792477934779447795477964779747798477994780047801478024780347804478054780647807478084780947810478114781247813478144781547816478174781847819478204782147822478234782447825478264782747828478294783047831478324783347834478354783647837478384783947840478414784247843478444784547846478474784847849478504785147852478534785447855478564785747858478594786047861478624786347864478654786647867478684786947870478714787247873478744787547876478774787847879478804788147882478834788447885478864788747888478894789047891478924789347894478954789647897478984789947900479014790247903479044790547906479074790847909479104791147912479134791447915479164791747918479194792047921479224792347924479254792647927479284792947930479314793247933479344793547936479374793847939479404794147942479434794447945479464794747948479494795047951479524795347954479554795647957479584795947960479614796247963479644796547966479674796847969479704797147972479734797447975479764797747978479794798047981479824798347984479854798647987479884798947990479914799247993479944799547996479974799847999480004800148002480034800448005480064800748008480094801048011480124801348014480154801648017480184801948020480214802248023480244802548026480274802848029480304803148032480334803448035480364803748038480394804048041480424804348044480454804648047480484804948050480514805248053480544805548056480574805848059480604806148062480634806448065480664806748068480694807048071480724807348074480754807648077480784807948080480814808248083480844808548086480874808848089480904809148092480934809448095480964809748098480994810048101481024810348104481054810648107481084810948110481114811248113481144811548116481174811848119481204812148122481234812448125481264812748128481294813048131481324813348134481354813648137481384813948140481414814248143481444814548146481474814848149481504815148152481534815448155481564815748158481594816048161481624816348164481654816648167481684816948170481714817248173481744817548176481774817848179481804818148182481834818448185481864818748188481894819048191481924819348194481954819648197481984819948200482014820248203482044820548206482074820848209482104821148212482134821448215482164821748218482194822048221482224822348224482254822648227482284822948230482314823248233482344823548236482374823848239482404824148242482434824448245482464824748248482494825048251482524825348254482554825648257482584825948260482614826248263482644826548266482674826848269482704827148272482734827448275482764827748278482794828048281482824828348284482854828648287482884828948290482914829248293482944829548296482974829848299483004830148302483034830448305483064830748308483094831048311483124831348314483154831648317483184831948320483214832248323483244832548326483274832848329483304833148332483334833448335483364833748338483394834048341483424834348344483454834648347483484834948350483514835248353483544835548356483574835848359483604836148362483634836448365483664836748368483694837048371483724837348374483754837648377483784837948380483814838248383483844838548386483874838848389483904839148392483934839448395483964839748398483994840048401484024840348404484054840648407484084840948410484114841248413484144841548416484174841848419484204842148422484234842448425484264842748428484294843048431484324843348434484354843648437484384843948440484414844248443484444844548446484474844848449484504845148452484534845448455484564845748458484594846048461484624846348464484654846648467484684846948470484714847248473484744847548476484774847848479484804848148482484834848448485484864848748488484894849048491484924849348494484954849648497484984849948500485014850248503485044850548506485074850848509485104851148512485134851448515485164851748518485194852048521485224852348524485254852648527485284852948530485314853248533485344853548536485374853848539485404854148542485434854448545485464854748548485494855048551485524855348554485554855648557485584855948560485614856248563485644856548566485674856848569485704857148572485734857448575485764857748578485794858048581485824858348584485854858648587485884858948590485914859248593485944859548596485974859848599486004860148602486034860448605486064860748608486094861048611486124861348614486154861648617486184861948620486214862248623486244862548626486274862848629486304863148632486334863448635486364863748638486394864048641486424864348644486454864648647486484864948650486514865248653486544865548656486574865848659486604866148662486634866448665486664866748668486694867048671486724867348674486754867648677486784867948680486814868248683486844868548686486874868848689486904869148692486934869448695486964869748698486994870048701487024870348704487054870648707487084870948710487114871248713487144871548716487174871848719487204872148722487234872448725487264872748728487294873048731487324873348734487354873648737487384873948740487414874248743487444874548746487474874848749487504875148752487534875448755487564875748758487594876048761487624876348764487654876648767487684876948770487714877248773487744877548776487774877848779487804878148782487834878448785487864878748788487894879048791487924879348794487954879648797487984879948800488014880248803488044880548806488074880848809488104881148812488134881448815488164881748818488194882048821488224882348824488254882648827488284882948830488314883248833488344883548836488374883848839488404884148842488434884448845488464884748848488494885048851488524885348854488554885648857488584885948860488614886248863488644886548866488674886848869488704887148872488734887448875488764887748878488794888048881488824888348884488854888648887488884888948890488914889248893488944889548896488974889848899489004890148902489034890448905489064890748908489094891048911489124891348914489154891648917489184891948920489214892248923489244892548926489274892848929489304893148932489334893448935489364893748938489394894048941489424894348944489454894648947489484894948950489514895248953489544895548956489574895848959489604896148962489634896448965489664896748968489694897048971489724897348974489754897648977489784897948980489814898248983489844898548986489874898848989489904899148992489934899448995489964899748998489994900049001490024900349004490054900649007490084900949010490114901249013490144901549016490174901849019490204902149022490234902449025490264902749028490294903049031490324903349034490354903649037490384903949040490414904249043490444904549046490474904849049490504905149052490534905449055490564905749058490594906049061490624906349064490654906649067490684906949070490714907249073490744907549076490774907849079490804908149082490834908449085490864908749088490894909049091490924909349094490954909649097490984909949100491014910249103491044910549106491074910849109491104911149112491134911449115491164911749118491194912049121491224912349124491254912649127491284912949130491314913249133491344913549136491374913849139491404914149142491434914449145491464914749148491494915049151491524915349154491554915649157491584915949160491614916249163491644916549166491674916849169491704917149172491734917449175491764917749178491794918049181491824918349184491854918649187491884918949190491914919249193491944919549196491974919849199492004920149202492034920449205492064920749208492094921049211492124921349214492154921649217492184921949220492214922249223492244922549226492274922849229492304923149232492334923449235492364923749238492394924049241492424924349244492454924649247492484924949250492514925249253492544925549256492574925849259492604926149262492634926449265492664926749268492694927049271492724927349274492754927649277492784927949280492814928249283492844928549286492874928849289492904929149292492934929449295492964929749298492994930049301493024930349304493054930649307493084930949310493114931249313493144931549316493174931849319493204932149322493234932449325493264932749328493294933049331493324933349334493354933649337493384933949340493414934249343493444934549346493474934849349493504935149352493534935449355493564935749358493594936049361493624936349364493654936649367493684936949370493714937249373493744937549376493774937849379493804938149382493834938449385493864938749388493894939049391493924939349394493954939649397493984939949400494014940249403494044940549406494074940849409494104941149412494134941449415494164941749418494194942049421494224942349424494254942649427494284942949430494314943249433494344943549436494374943849439494404944149442494434944449445494464944749448494494945049451494524945349454494554945649457494584945949460494614946249463494644946549466494674946849469494704947149472494734947449475494764947749478494794948049481494824948349484494854948649487494884948949490494914949249493494944949549496494974949849499495004950149502495034950449505495064950749508495094951049511495124951349514495154951649517495184951949520495214952249523495244952549526495274952849529495304953149532495334953449535495364953749538495394954049541495424954349544495454954649547495484954949550495514955249553495544955549556495574955849559495604956149562495634956449565495664956749568495694957049571495724957349574495754957649577495784957949580495814958249583495844958549586495874958849589495904959149592495934959449595495964959749598495994960049601496024960349604496054960649607496084960949610496114961249613496144961549616496174961849619496204962149622496234962449625496264962749628496294963049631496324963349634496354963649637496384963949640496414964249643496444964549646496474964849649496504965149652496534965449655496564965749658496594966049661496624966349664496654966649667496684966949670496714967249673496744967549676496774967849679496804968149682496834968449685496864968749688496894969049691496924969349694496954969649697496984969949700497014970249703497044970549706497074970849709497104971149712497134971449715497164971749718497194972049721497224972349724497254972649727497284972949730497314973249733497344973549736497374973849739497404974149742497434974449745497464974749748497494975049751497524975349754497554975649757497584975949760497614976249763497644976549766497674976849769497704977149772497734977449775497764977749778497794978049781497824978349784497854978649787497884978949790497914979249793497944979549796497974979849799498004980149802498034980449805498064980749808498094981049811498124981349814498154981649817498184981949820498214982249823498244982549826498274982849829498304983149832498334983449835498364983749838498394984049841498424984349844498454984649847498484984949850498514985249853498544985549856498574985849859498604986149862498634986449865498664986749868498694987049871498724987349874498754987649877498784987949880498814988249883498844988549886498874988849889498904989149892498934989449895498964989749898498994990049901499024990349904499054990649907499084990949910499114991249913499144991549916499174991849919499204992149922499234992449925499264992749928499294993049931499324993349934499354993649937499384993949940499414994249943499444994549946499474994849949499504995149952499534995449955499564995749958499594996049961499624996349964499654996649967499684996949970499714997249973499744997549976499774997849979499804998149982499834998449985499864998749988499894999049991499924999349994499954999649997499984999950000500015000250003500045000550006500075000850009500105001150012500135001450015500165001750018500195002050021500225002350024500255002650027500285002950030500315003250033500345003550036500375003850039500405004150042500435004450045500465004750048500495005050051500525005350054500555005650057500585005950060500615006250063500645006550066500675006850069500705007150072500735007450075500765007750078500795008050081500825008350084500855008650087500885008950090500915009250093500945009550096500975009850099501005010150102501035010450105501065010750108501095011050111501125011350114501155011650117501185011950120501215012250123501245012550126501275012850129501305013150132501335013450135501365013750138501395014050141501425014350144501455014650147501485014950150501515015250153501545015550156501575015850159501605016150162501635016450165501665016750168501695017050171501725017350174501755017650177501785017950180501815018250183501845018550186501875018850189501905019150192501935019450195501965019750198501995020050201502025020350204502055020650207502085020950210502115021250213502145021550216502175021850219502205022150222502235022450225502265022750228502295023050231502325023350234502355023650237502385023950240502415024250243502445024550246502475024850249502505025150252502535025450255502565025750258502595026050261502625026350264502655026650267502685026950270502715027250273502745027550276502775027850279502805028150282502835028450285502865028750288502895029050291502925029350294502955029650297502985029950300503015030250303503045030550306503075030850309503105031150312503135031450315503165031750318503195032050321503225032350324503255032650327503285032950330503315033250333503345033550336503375033850339503405034150342503435034450345503465034750348503495035050351503525035350354503555035650357503585035950360503615036250363503645036550366503675036850369503705037150372503735037450375503765037750378503795038050381503825038350384503855038650387503885038950390503915039250393503945039550396503975039850399504005040150402504035040450405504065040750408504095041050411504125041350414504155041650417504185041950420504215042250423504245042550426504275042850429504305043150432504335043450435504365043750438504395044050441504425044350444504455044650447504485044950450504515045250453504545045550456504575045850459504605046150462504635046450465504665046750468504695047050471504725047350474504755047650477504785047950480504815048250483504845048550486504875048850489504905049150492504935049450495504965049750498504995050050501505025050350504505055050650507505085050950510505115051250513505145051550516505175051850519505205052150522505235052450525505265052750528505295053050531505325053350534505355053650537505385053950540505415054250543505445054550546505475054850549505505055150552505535055450555505565055750558505595056050561505625056350564505655056650567505685056950570505715057250573505745057550576505775057850579505805058150582505835058450585505865058750588505895059050591505925059350594505955059650597505985059950600506015060250603506045060550606506075060850609506105061150612506135061450615506165061750618506195062050621506225062350624506255062650627506285062950630506315063250633506345063550636506375063850639506405064150642506435064450645506465064750648506495065050651506525065350654506555065650657506585065950660506615066250663506645066550666506675066850669506705067150672506735067450675506765067750678506795068050681506825068350684506855068650687506885068950690506915069250693506945069550696506975069850699507005070150702507035070450705507065070750708507095071050711507125071350714507155071650717507185071950720507215072250723507245072550726507275072850729507305073150732507335073450735507365073750738507395074050741507425074350744507455074650747507485074950750507515075250753507545075550756507575075850759507605076150762507635076450765507665076750768507695077050771507725077350774507755077650777507785077950780507815078250783507845078550786507875078850789507905079150792507935079450795507965079750798507995080050801508025080350804508055080650807508085080950810508115081250813508145081550816508175081850819508205082150822508235082450825508265082750828508295083050831508325083350834508355083650837508385083950840508415084250843508445084550846508475084850849508505085150852508535085450855508565085750858508595086050861508625086350864508655086650867508685086950870508715087250873508745087550876508775087850879508805088150882508835088450885508865088750888508895089050891508925089350894508955089650897508985089950900509015090250903509045090550906509075090850909509105091150912509135091450915509165091750918509195092050921509225092350924509255092650927509285092950930509315093250933509345093550936509375093850939509405094150942509435094450945509465094750948509495095050951509525095350954509555095650957509585095950960509615096250963509645096550966509675096850969509705097150972509735097450975509765097750978509795098050981509825098350984509855098650987509885098950990509915099250993509945099550996509975099850999510005100151002510035100451005510065100751008510095101051011510125101351014510155101651017510185101951020510215102251023510245102551026510275102851029510305103151032510335103451035510365103751038510395104051041510425104351044510455104651047510485104951050510515105251053510545105551056510575105851059510605106151062510635106451065510665106751068510695107051071510725107351074510755107651077510785107951080510815108251083510845108551086510875108851089510905109151092510935109451095510965109751098510995110051101511025110351104511055110651107511085110951110511115111251113511145111551116511175111851119511205112151122511235112451125511265112751128511295113051131511325113351134511355113651137511385113951140511415114251143511445114551146511475114851149511505115151152511535115451155511565115751158511595116051161511625116351164511655116651167511685116951170511715117251173511745117551176511775117851179511805118151182511835118451185511865118751188511895119051191511925119351194511955119651197511985119951200512015120251203512045120551206512075120851209512105121151212512135121451215512165121751218512195122051221512225122351224512255122651227512285122951230512315123251233512345123551236512375123851239512405124151242512435124451245512465124751248512495125051251512525125351254512555125651257512585125951260512615126251263512645126551266512675126851269512705127151272512735127451275512765127751278512795128051281512825128351284512855128651287512885128951290512915129251293512945129551296512975129851299513005130151302513035130451305513065130751308513095131051311513125131351314513155131651317513185131951320513215132251323513245132551326513275132851329513305133151332513335133451335513365133751338513395134051341513425134351344513455134651347513485134951350513515135251353513545135551356513575135851359513605136151362513635136451365513665136751368513695137051371513725137351374513755137651377513785137951380513815138251383513845138551386513875138851389513905139151392513935139451395513965139751398513995140051401514025140351404514055140651407514085140951410514115141251413514145141551416514175141851419514205142151422514235142451425514265142751428514295143051431514325143351434514355143651437514385143951440514415144251443514445144551446514475144851449514505145151452514535145451455514565145751458514595146051461514625146351464514655146651467514685146951470514715147251473514745147551476514775147851479514805148151482514835148451485514865148751488514895149051491514925149351494514955149651497514985149951500515015150251503515045150551506515075150851509515105151151512515135151451515515165151751518515195152051521515225152351524515255152651527515285152951530515315153251533515345153551536515375153851539515405154151542515435154451545515465154751548515495155051551515525155351554515555155651557515585155951560515615156251563515645156551566515675156851569515705157151572515735157451575515765157751578515795158051581515825158351584515855158651587515885158951590515915159251593515945159551596515975159851599516005160151602516035160451605516065160751608516095161051611516125161351614516155161651617516185161951620516215162251623516245162551626516275162851629516305163151632516335163451635516365163751638516395164051641516425164351644516455164651647516485164951650516515165251653516545165551656516575165851659516605166151662516635166451665516665166751668516695167051671516725167351674516755167651677516785167951680516815168251683516845168551686516875168851689516905169151692516935169451695516965169751698516995170051701517025170351704517055170651707517085170951710517115171251713517145171551716517175171851719517205172151722517235172451725517265172751728517295173051731517325173351734517355173651737517385173951740517415174251743517445174551746517475174851749517505175151752517535175451755517565175751758517595176051761517625176351764517655176651767517685176951770517715177251773517745177551776517775177851779517805178151782517835178451785517865178751788517895179051791517925179351794517955179651797517985179951800518015180251803518045180551806518075180851809518105181151812518135181451815518165181751818518195182051821518225182351824518255182651827518285182951830518315183251833518345183551836518375183851839518405184151842518435184451845518465184751848518495185051851518525185351854518555185651857518585185951860518615186251863518645186551866518675186851869518705187151872518735187451875518765187751878518795188051881518825188351884518855188651887518885188951890518915189251893518945189551896518975189851899519005190151902519035190451905519065190751908519095191051911519125191351914519155191651917519185191951920519215192251923519245192551926519275192851929519305193151932519335193451935519365193751938519395194051941519425194351944519455194651947519485194951950519515195251953519545195551956519575195851959519605196151962519635196451965519665196751968519695197051971519725197351974519755197651977519785197951980519815198251983519845198551986519875198851989519905199151992519935199451995519965199751998519995200052001520025200352004520055200652007520085200952010520115201252013520145201552016520175201852019520205202152022520235202452025520265202752028520295203052031520325203352034520355203652037520385203952040520415204252043520445204552046520475204852049520505205152052520535205452055520565205752058520595206052061520625206352064520655206652067520685206952070520715207252073520745207552076520775207852079520805208152082520835208452085520865208752088520895209052091520925209352094520955209652097520985209952100521015210252103521045210552106521075210852109521105211152112521135211452115521165211752118521195212052121521225212352124521255212652127521285212952130521315213252133521345213552136521375213852139521405214152142521435214452145521465214752148521495215052151521525215352154521555215652157521585215952160521615216252163521645216552166521675216852169521705217152172521735217452175521765217752178521795218052181521825218352184521855218652187521885218952190521915219252193521945219552196521975219852199522005220152202522035220452205522065220752208522095221052211522125221352214522155221652217522185221952220522215222252223522245222552226522275222852229522305223152232522335223452235522365223752238522395224052241522425224352244522455224652247522485224952250522515225252253522545225552256522575225852259522605226152262522635226452265522665226752268522695227052271522725227352274522755227652277522785227952280522815228252283522845228552286522875228852289522905229152292522935229452295522965229752298522995230052301523025230352304523055230652307523085230952310523115231252313523145231552316523175231852319523205232152322523235232452325523265232752328523295233052331523325233352334523355233652337523385233952340523415234252343523445234552346523475234852349523505235152352523535235452355523565235752358523595236052361523625236352364523655236652367523685236952370523715237252373523745237552376523775237852379523805238152382523835238452385523865238752388523895239052391523925239352394523955239652397523985239952400524015240252403524045240552406524075240852409524105241152412524135241452415524165241752418524195242052421524225242352424524255242652427524285242952430524315243252433524345243552436524375243852439524405244152442524435244452445524465244752448524495245052451524525245352454524555245652457524585245952460524615246252463524645246552466524675246852469524705247152472524735247452475524765247752478524795248052481524825248352484524855248652487524885248952490524915249252493524945249552496524975249852499525005250152502525035250452505525065250752508525095251052511525125251352514525155251652517525185251952520525215252252523525245252552526525275252852529525305253152532525335253452535525365253752538525395254052541525425254352544525455254652547525485254952550525515255252553525545255552556525575255852559525605256152562525635256452565525665256752568525695257052571525725257352574525755257652577525785257952580525815258252583525845258552586525875258852589525905259152592525935259452595525965259752598525995260052601526025260352604526055260652607526085260952610526115261252613526145261552616526175261852619526205262152622526235262452625526265262752628526295263052631526325263352634526355263652637526385263952640526415264252643526445264552646526475264852649526505265152652526535265452655526565265752658526595266052661526625266352664526655266652667526685266952670526715267252673526745267552676526775267852679526805268152682526835268452685526865268752688526895269052691526925269352694526955269652697526985269952700527015270252703527045270552706527075270852709527105271152712527135271452715527165271752718527195272052721527225272352724527255272652727527285272952730527315273252733527345273552736527375273852739527405274152742527435274452745527465274752748527495275052751527525275352754527555275652757527585275952760527615276252763527645276552766527675276852769527705277152772527735277452775527765277752778527795278052781527825278352784527855278652787527885278952790527915279252793527945279552796527975279852799528005280152802528035280452805528065280752808528095281052811528125281352814528155281652817528185281952820528215282252823528245282552826528275282852829528305283152832528335283452835528365283752838528395284052841528425284352844528455284652847528485284952850528515285252853528545285552856528575285852859528605286152862528635286452865528665286752868528695287052871528725287352874528755287652877528785287952880528815288252883528845288552886528875288852889528905289152892528935289452895528965289752898528995290052901529025290352904529055290652907529085290952910529115291252913529145291552916529175291852919529205292152922529235292452925529265292752928529295293052931529325293352934529355293652937529385293952940529415294252943529445294552946529475294852949529505295152952529535295452955529565295752958529595296052961529625296352964529655296652967529685296952970529715297252973529745297552976529775297852979529805298152982529835298452985529865298752988529895299052991529925299352994529955299652997529985299953000530015300253003530045300553006530075300853009530105301153012530135301453015530165301753018530195302053021530225302353024530255302653027530285302953030530315303253033530345303553036530375303853039530405304153042530435304453045530465304753048530495305053051530525305353054530555305653057530585305953060530615306253063530645306553066530675306853069530705307153072530735307453075530765307753078530795308053081530825308353084530855308653087530885308953090530915309253093530945309553096530975309853099531005310153102531035310453105531065310753108531095311053111531125311353114531155311653117531185311953120531215312253123531245312553126531275312853129531305313153132531335313453135531365313753138531395314053141531425314353144531455314653147531485314953150531515315253153531545315553156531575315853159531605316153162531635316453165531665316753168531695317053171531725317353174531755317653177531785317953180531815318253183531845318553186531875318853189531905319153192531935319453195531965319753198531995320053201532025320353204532055320653207532085320953210532115321253213532145321553216532175321853219532205322153222532235322453225532265322753228532295323053231532325323353234532355323653237532385323953240532415324253243532445324553246532475324853249532505325153252532535325453255532565325753258532595326053261532625326353264532655326653267532685326953270532715327253273532745327553276532775327853279532805328153282532835328453285532865328753288532895329053291532925329353294532955329653297532985329953300533015330253303533045330553306533075330853309533105331153312533135331453315533165331753318533195332053321533225332353324533255332653327533285332953330533315333253333533345333553336533375333853339533405334153342533435334453345533465334753348533495335053351533525335353354533555335653357533585335953360533615336253363533645336553366533675336853369533705337153372533735337453375533765337753378533795338053381533825338353384533855338653387533885338953390533915339253393533945339553396533975339853399534005340153402534035340453405534065340753408534095341053411534125341353414534155341653417534185341953420534215342253423534245342553426534275342853429534305343153432534335343453435534365343753438534395344053441534425344353444534455344653447534485344953450534515345253453534545345553456534575345853459534605346153462534635346453465534665346753468534695347053471534725347353474534755347653477534785347953480534815348253483534845348553486534875348853489534905349153492534935349453495534965349753498534995350053501535025350353504535055350653507535085350953510535115351253513535145351553516535175351853519535205352153522535235352453525535265352753528535295353053531535325353353534535355353653537535385353953540535415354253543535445354553546535475354853549535505355153552535535355453555535565355753558535595356053561535625356353564535655356653567535685356953570535715357253573535745357553576535775357853579535805358153582535835358453585535865358753588535895359053591535925359353594535955359653597535985359953600536015360253603536045360553606536075360853609536105361153612536135361453615536165361753618536195362053621536225362353624536255362653627536285362953630536315363253633536345363553636536375363853639536405364153642536435364453645536465364753648536495365053651536525365353654536555365653657536585365953660536615366253663536645366553666536675366853669536705367153672536735367453675536765367753678536795368053681536825368353684536855368653687536885368953690536915369253693536945369553696536975369853699537005370153702537035370453705537065370753708537095371053711537125371353714537155371653717537185371953720537215372253723537245372553726537275372853729537305373153732537335373453735537365373753738537395374053741537425374353744537455374653747537485374953750537515375253753537545375553756537575375853759537605376153762537635376453765537665376753768537695377053771537725377353774537755377653777537785377953780537815378253783537845378553786537875378853789537905379153792537935379453795537965379753798537995380053801538025380353804538055380653807538085380953810538115381253813538145381553816538175381853819538205382153822538235382453825538265382753828538295383053831538325383353834538355383653837538385383953840538415384253843538445384553846538475384853849538505385153852538535385453855538565385753858538595386053861538625386353864538655386653867538685386953870538715387253873538745387553876538775387853879538805388153882538835388453885538865388753888538895389053891538925389353894538955389653897538985389953900539015390253903539045390553906539075390853909539105391153912539135391453915539165391753918539195392053921539225392353924539255392653927539285392953930539315393253933539345393553936539375393853939539405394153942539435394453945539465394753948539495395053951539525395353954539555395653957539585395953960539615396253963539645396553966539675396853969539705397153972539735397453975539765397753978539795398053981539825398353984539855398653987539885398953990539915399253993539945399553996539975399853999540005400154002540035400454005540065400754008540095401054011540125401354014540155401654017540185401954020540215402254023540245402554026540275402854029540305403154032540335403454035540365403754038540395404054041540425404354044540455404654047540485404954050540515405254053540545405554056540575405854059540605406154062540635406454065540665406754068540695407054071540725407354074540755407654077540785407954080540815408254083540845408554086540875408854089540905409154092540935409454095540965409754098540995410054101541025410354104541055410654107541085410954110541115411254113541145411554116541175411854119541205412154122541235412454125541265412754128541295413054131541325413354134541355413654137541385413954140541415414254143541445414554146541475414854149541505415154152541535415454155541565415754158541595416054161541625416354164541655416654167541685416954170541715417254173541745417554176541775417854179541805418154182541835418454185541865418754188541895419054191541925419354194541955419654197541985419954200542015420254203542045420554206542075420854209542105421154212542135421454215542165421754218542195422054221542225422354224542255422654227542285422954230542315423254233542345423554236542375423854239542405424154242542435424454245542465424754248542495425054251542525425354254542555425654257542585425954260542615426254263542645426554266542675426854269542705427154272542735427454275542765427754278542795428054281542825428354284542855428654287542885428954290542915429254293542945429554296542975429854299543005430154302543035430454305543065430754308543095431054311543125431354314543155431654317543185431954320543215432254323543245432554326543275432854329543305433154332543335433454335543365433754338543395434054341543425434354344543455434654347543485434954350543515435254353543545435554356543575435854359543605436154362543635436454365543665436754368543695437054371543725437354374543755437654377543785437954380543815438254383543845438554386543875438854389543905439154392543935439454395543965439754398543995440054401544025440354404544055440654407544085440954410544115441254413544145441554416544175441854419544205442154422544235442454425544265442754428544295443054431544325443354434544355443654437544385443954440544415444254443544445444554446544475444854449544505445154452544535445454455544565445754458544595446054461544625446354464544655446654467544685446954470544715447254473544745447554476544775447854479544805448154482544835448454485544865448754488544895449054491544925449354494544955449654497544985449954500545015450254503545045450554506545075450854509545105451154512545135451454515545165451754518545195452054521545225452354524545255452654527545285452954530545315453254533545345453554536545375453854539545405454154542545435454454545545465454754548545495455054551545525455354554545555455654557545585455954560545615456254563545645456554566545675456854569545705457154572545735457454575545765457754578545795458054581545825458354584545855458654587545885458954590545915459254593545945459554596545975459854599546005460154602546035460454605546065460754608546095461054611546125461354614546155461654617546185461954620546215462254623546245462554626546275462854629546305463154632546335463454635546365463754638546395464054641546425464354644546455464654647546485464954650546515465254653546545465554656546575465854659546605466154662546635466454665546665466754668546695467054671546725467354674546755467654677546785467954680546815468254683546845468554686546875468854689546905469154692546935469454695546965469754698546995470054701547025470354704547055470654707547085470954710547115471254713547145471554716547175471854719547205472154722547235472454725547265472754728547295473054731547325473354734547355473654737547385473954740547415474254743547445474554746547475474854749547505475154752547535475454755547565475754758547595476054761547625476354764547655476654767547685476954770547715477254773547745477554776547775477854779547805478154782547835478454785547865478754788547895479054791547925479354794547955479654797547985479954800548015480254803548045480554806548075480854809548105481154812548135481454815548165481754818548195482054821548225482354824548255482654827548285482954830548315483254833548345483554836548375483854839548405484154842548435484454845548465484754848548495485054851548525485354854548555485654857548585485954860548615486254863548645486554866548675486854869548705487154872548735487454875548765487754878548795488054881548825488354884548855488654887548885488954890548915489254893548945489554896548975489854899549005490154902549035490454905549065490754908549095491054911549125491354914549155491654917549185491954920549215492254923549245492554926549275492854929549305493154932549335493454935549365493754938549395494054941549425494354944549455494654947549485494954950549515495254953549545495554956549575495854959549605496154962549635496454965549665496754968549695497054971549725497354974549755497654977549785497954980549815498254983549845498554986549875498854989549905499154992549935499454995549965499754998549995500055001550025500355004550055500655007550085500955010550115501255013550145501555016550175501855019550205502155022550235502455025550265502755028550295503055031550325503355034550355503655037550385503955040550415504255043550445504555046550475504855049550505505155052550535505455055550565505755058550595506055061550625506355064550655506655067550685506955070550715507255073550745507555076550775507855079550805508155082550835508455085550865508755088550895509055091550925509355094550955509655097550985509955100551015510255103551045510555106551075510855109551105511155112551135511455115551165511755118551195512055121551225512355124551255512655127551285512955130551315513255133551345513555136551375513855139551405514155142551435514455145551465514755148551495515055151551525515355154551555515655157551585515955160551615516255163551645516555166551675516855169551705517155172551735517455175551765517755178551795518055181551825518355184551855518655187551885518955190551915519255193551945519555196551975519855199552005520155202552035520455205552065520755208552095521055211552125521355214552155521655217552185521955220552215522255223552245522555226552275522855229552305523155232552335523455235552365523755238552395524055241552425524355244552455524655247552485524955250552515525255253552545525555256552575525855259552605526155262552635526455265552665526755268552695527055271552725527355274552755527655277552785527955280552815528255283552845528555286552875528855289552905529155292552935529455295552965529755298552995530055301553025530355304553055530655307553085530955310553115531255313553145531555316553175531855319553205532155322553235532455325553265532755328553295533055331553325533355334553355533655337553385533955340553415534255343553445534555346553475534855349553505535155352553535535455355553565535755358553595536055361553625536355364553655536655367553685536955370553715537255373553745537555376553775537855379553805538155382553835538455385553865538755388553895539055391553925539355394553955539655397553985539955400554015540255403554045540555406554075540855409554105541155412554135541455415554165541755418554195542055421554225542355424554255542655427554285542955430554315543255433554345543555436554375543855439554405544155442554435544455445554465544755448554495545055451554525545355454554555545655457554585545955460554615546255463554645546555466554675546855469554705547155472554735547455475554765547755478554795548055481554825548355484554855548655487554885548955490554915549255493554945549555496554975549855499555005550155502555035550455505555065550755508555095551055511555125551355514555155551655517555185551955520555215552255523555245552555526555275552855529555305553155532555335553455535555365553755538555395554055541555425554355544555455554655547555485554955550555515555255553555545555555556555575555855559555605556155562555635556455565555665556755568555695557055571555725557355574555755557655577555785557955580555815558255583555845558555586555875558855589555905559155592555935559455595555965559755598555995560055601556025560355604556055560655607556085560955610556115561255613556145561555616556175561855619556205562155622556235562455625556265562755628556295563055631556325563355634556355563655637556385563955640556415564255643556445564555646556475564855649556505565155652556535565455655556565565755658556595566055661556625566355664556655566655667556685566955670556715567255673556745567555676556775567855679556805568155682556835568455685556865568755688556895569055691556925569355694556955569655697556985569955700557015570255703557045570555706557075570855709557105571155712557135571455715557165571755718557195572055721557225572355724557255572655727557285572955730557315573255733557345573555736557375573855739557405574155742557435574455745557465574755748557495575055751557525575355754557555575655757557585575955760557615576255763557645576555766557675576855769557705577155772557735577455775557765577755778557795578055781557825578355784557855578655787557885578955790557915579255793557945579555796557975579855799558005580155802558035580455805558065580755808558095581055811558125581355814558155581655817558185581955820558215582255823558245582555826558275582855829558305583155832558335583455835558365583755838558395584055841558425584355844558455584655847558485584955850558515585255853558545585555856558575585855859558605586155862558635586455865558665586755868558695587055871558725587355874558755587655877558785587955880558815588255883558845588555886558875588855889558905589155892558935589455895558965589755898558995590055901559025590355904559055590655907559085590955910559115591255913559145591555916559175591855919559205592155922559235592455925559265592755928559295593055931559325593355934559355593655937559385593955940559415594255943559445594555946559475594855949559505595155952559535595455955559565595755958559595596055961559625596355964559655596655967559685596955970559715597255973559745597555976559775597855979559805598155982559835598455985559865598755988559895599055991559925599355994559955599655997559985599956000560015600256003560045600556006560075600856009560105601156012560135601456015560165601756018560195602056021560225602356024560255602656027560285602956030560315603256033560345603556036560375603856039560405604156042560435604456045560465604756048560495605056051560525605356054560555605656057560585605956060560615606256063560645606556066560675606856069560705607156072560735607456075560765607756078560795608056081560825608356084560855608656087560885608956090560915609256093560945609556096560975609856099561005610156102561035610456105561065610756108561095611056111561125611356114561155611656117561185611956120561215612256123561245612556126561275612856129561305613156132561335613456135561365613756138561395614056141561425614356144561455614656147561485614956150561515615256153561545615556156561575615856159561605616156162561635616456165561665616756168561695617056171561725617356174561755617656177561785617956180561815618256183561845618556186561875618856189561905619156192561935619456195561965619756198561995620056201562025620356204562055620656207562085620956210562115621256213562145621556216562175621856219562205622156222562235622456225562265622756228562295623056231562325623356234562355623656237562385623956240562415624256243562445624556246562475624856249562505625156252562535625456255562565625756258562595626056261562625626356264562655626656267562685626956270562715627256273562745627556276562775627856279562805628156282562835628456285562865628756288562895629056291562925629356294562955629656297562985629956300563015630256303563045630556306563075630856309563105631156312563135631456315563165631756318563195632056321563225632356324563255632656327563285632956330563315633256333563345633556336563375633856339563405634156342563435634456345563465634756348563495635056351563525635356354563555635656357563585635956360563615636256363563645636556366563675636856369563705637156372563735637456375563765637756378563795638056381563825638356384563855638656387563885638956390563915639256393563945639556396563975639856399564005640156402564035640456405564065640756408564095641056411564125641356414564155641656417564185641956420564215642256423564245642556426564275642856429564305643156432564335643456435564365643756438564395644056441564425644356444564455644656447564485644956450564515645256453564545645556456564575645856459564605646156462564635646456465564665646756468564695647056471564725647356474564755647656477564785647956480564815648256483564845648556486564875648856489564905649156492564935649456495564965649756498564995650056501565025650356504565055650656507565085650956510565115651256513565145651556516565175651856519565205652156522565235652456525565265652756528565295653056531565325653356534565355653656537565385653956540565415654256543565445654556546565475654856549565505655156552565535655456555565565655756558565595656056561565625656356564565655656656567565685656956570565715657256573565745657556576565775657856579565805658156582565835658456585565865658756588565895659056591565925659356594565955659656597565985659956600566015660256603566045660556606566075660856609566105661156612566135661456615566165661756618566195662056621566225662356624566255662656627566285662956630566315663256633566345663556636566375663856639566405664156642566435664456645566465664756648566495665056651566525665356654566555665656657566585665956660566615666256663566645666556666566675666856669566705667156672566735667456675566765667756678566795668056681566825668356684566855668656687566885668956690566915669256693566945669556696566975669856699567005670156702567035670456705567065670756708567095671056711567125671356714567155671656717567185671956720567215672256723567245672556726567275672856729567305673156732567335673456735567365673756738567395674056741567425674356744567455674656747567485674956750567515675256753567545675556756567575675856759567605676156762567635676456765567665676756768567695677056771567725677356774567755677656777567785677956780567815678256783567845678556786567875678856789567905679156792567935679456795567965679756798567995680056801568025680356804568055680656807568085680956810568115681256813568145681556816568175681856819568205682156822568235682456825568265682756828568295683056831568325683356834568355683656837568385683956840568415684256843568445684556846568475684856849568505685156852568535685456855568565685756858568595686056861568625686356864568655686656867568685686956870568715687256873568745687556876568775687856879568805688156882568835688456885568865688756888568895689056891568925689356894568955689656897568985689956900569015690256903569045690556906569075690856909569105691156912569135691456915569165691756918569195692056921569225692356924569255692656927569285692956930569315693256933569345693556936569375693856939569405694156942569435694456945569465694756948569495695056951569525695356954569555695656957569585695956960569615696256963569645696556966569675696856969569705697156972569735697456975569765697756978569795698056981569825698356984569855698656987569885698956990569915699256993569945699556996569975699856999570005700157002570035700457005570065700757008570095701057011570125701357014570155701657017570185701957020570215702257023570245702557026570275702857029570305703157032570335703457035570365703757038570395704057041570425704357044570455704657047570485704957050570515705257053570545705557056570575705857059570605706157062570635706457065570665706757068570695707057071570725707357074570755707657077570785707957080570815708257083570845708557086570875708857089570905709157092570935709457095570965709757098570995710057101571025710357104571055710657107571085710957110571115711257113571145711557116571175711857119571205712157122571235712457125571265712757128571295713057131571325713357134571355713657137571385713957140571415714257143571445714557146571475714857149571505715157152571535715457155571565715757158571595716057161571625716357164571655716657167571685716957170571715717257173571745717557176571775717857179571805718157182571835718457185571865718757188571895719057191571925719357194571955719657197571985719957200572015720257203572045720557206572075720857209572105721157212572135721457215572165721757218572195722057221572225722357224572255722657227572285722957230572315723257233572345723557236572375723857239572405724157242572435724457245572465724757248572495725057251572525725357254572555725657257572585725957260572615726257263572645726557266572675726857269572705727157272572735727457275572765727757278572795728057281572825728357284572855728657287572885728957290572915729257293572945729557296572975729857299573005730157302573035730457305573065730757308573095731057311573125731357314573155731657317573185731957320573215732257323573245732557326573275732857329573305733157332573335733457335573365733757338573395734057341573425734357344573455734657347573485734957350573515735257353573545735557356573575735857359573605736157362573635736457365573665736757368573695737057371573725737357374573755737657377573785737957380573815738257383573845738557386573875738857389573905739157392573935739457395573965739757398573995740057401574025740357404574055740657407574085740957410574115741257413574145741557416574175741857419574205742157422574235742457425574265742757428574295743057431574325743357434574355743657437574385743957440574415744257443574445744557446574475744857449574505745157452574535745457455574565745757458574595746057461574625746357464574655746657467574685746957470574715747257473574745747557476574775747857479574805748157482574835748457485574865748757488574895749057491574925749357494574955749657497574985749957500575015750257503575045750557506575075750857509575105751157512575135751457515575165751757518575195752057521575225752357524575255752657527575285752957530575315753257533575345753557536575375753857539575405754157542575435754457545575465754757548575495755057551575525755357554575555755657557575585755957560575615756257563575645756557566575675756857569575705757157572575735757457575575765757757578575795758057581575825758357584575855758657587575885758957590575915759257593575945759557596575975759857599576005760157602576035760457605576065760757608576095761057611576125761357614576155761657617576185761957620576215762257623576245762557626576275762857629576305763157632576335763457635576365763757638576395764057641576425764357644576455764657647576485764957650576515765257653576545765557656576575765857659576605766157662576635766457665576665766757668576695767057671576725767357674576755767657677576785767957680576815768257683576845768557686576875768857689576905769157692576935769457695576965769757698576995770057701577025770357704577055770657707577085770957710577115771257713577145771557716577175771857719577205772157722577235772457725577265772757728577295773057731577325773357734577355773657737577385773957740577415774257743577445774557746577475774857749577505775157752577535775457755577565775757758577595776057761577625776357764577655776657767577685776957770577715777257773577745777557776577775777857779577805778157782577835778457785577865778757788577895779057791577925779357794577955779657797577985779957800578015780257803578045780557806578075780857809578105781157812578135781457815578165781757818578195782057821578225782357824578255782657827578285782957830578315783257833578345783557836578375783857839578405784157842578435784457845578465784757848578495785057851578525785357854578555785657857578585785957860578615786257863578645786557866578675786857869578705787157872578735787457875578765787757878578795788057881578825788357884578855788657887578885788957890578915789257893578945789557896578975789857899579005790157902579035790457905579065790757908579095791057911579125791357914579155791657917579185791957920579215792257923579245792557926579275792857929579305793157932579335793457935579365793757938579395794057941579425794357944579455794657947579485794957950579515795257953579545795557956579575795857959579605796157962579635796457965579665796757968579695797057971579725797357974579755797657977579785797957980579815798257983579845798557986579875798857989579905799157992579935799457995579965799757998579995800058001580025800358004580055800658007580085800958010580115801258013580145801558016580175801858019580205802158022580235802458025580265802758028580295803058031580325803358034580355803658037580385803958040580415804258043580445804558046580475804858049580505805158052580535805458055580565805758058580595806058061580625806358064580655806658067580685806958070580715807258073580745807558076580775807858079580805808158082580835808458085580865808758088580895809058091580925809358094580955809658097580985809958100581015810258103581045810558106581075810858109581105811158112581135811458115581165811758118581195812058121581225812358124581255812658127581285812958130581315813258133581345813558136581375813858139581405814158142581435814458145581465814758148581495815058151581525815358154581555815658157581585815958160581615816258163581645816558166581675816858169581705817158172581735817458175581765817758178581795818058181581825818358184581855818658187581885818958190581915819258193581945819558196581975819858199582005820158202582035820458205582065820758208582095821058211582125821358214582155821658217582185821958220582215822258223582245822558226582275822858229582305823158232582335823458235582365823758238582395824058241582425824358244582455824658247582485824958250582515825258253582545825558256582575825858259582605826158262582635826458265582665826758268582695827058271582725827358274582755827658277582785827958280582815828258283582845828558286582875828858289582905829158292582935829458295582965829758298582995830058301583025830358304583055830658307583085830958310583115831258313583145831558316583175831858319583205832158322583235832458325583265832758328583295833058331583325833358334583355833658337583385833958340583415834258343583445834558346583475834858349583505835158352583535835458355583565835758358583595836058361583625836358364583655836658367583685836958370583715837258373583745837558376583775837858379583805838158382583835838458385583865838758388583895839058391583925839358394583955839658397583985839958400584015840258403584045840558406584075840858409584105841158412584135841458415584165841758418584195842058421584225842358424584255842658427584285842958430584315843258433584345843558436584375843858439584405844158442584435844458445584465844758448584495845058451584525845358454584555845658457584585845958460584615846258463584645846558466584675846858469584705847158472584735847458475584765847758478584795848058481584825848358484584855848658487584885848958490584915849258493584945849558496584975849858499585005850158502585035850458505585065850758508585095851058511585125851358514585155851658517585185851958520585215852258523585245852558526585275852858529585305853158532585335853458535585365853758538585395854058541585425854358544585455854658547585485854958550585515855258553585545855558556585575855858559585605856158562585635856458565585665856758568585695857058571585725857358574585755857658577585785857958580585815858258583585845858558586585875858858589585905859158592585935859458595585965859758598585995860058601586025860358604586055860658607586085860958610586115861258613586145861558616586175861858619586205862158622586235862458625586265862758628586295863058631586325863358634586355863658637586385863958640586415864258643586445864558646586475864858649586505865158652586535865458655586565865758658586595866058661586625866358664586655866658667586685866958670586715867258673586745867558676586775867858679586805868158682586835868458685586865868758688586895869058691586925869358694586955869658697586985869958700587015870258703587045870558706587075870858709587105871158712587135871458715587165871758718587195872058721587225872358724587255872658727587285872958730587315873258733587345873558736587375873858739587405874158742587435874458745587465874758748587495875058751587525875358754587555875658757587585875958760587615876258763587645876558766587675876858769587705877158772587735877458775587765877758778587795878058781587825878358784587855878658787587885878958790587915879258793587945879558796587975879858799588005880158802588035880458805588065880758808588095881058811588125881358814588155881658817588185881958820588215882258823588245882558826588275882858829588305883158832588335883458835588365883758838588395884058841588425884358844588455884658847588485884958850588515885258853588545885558856588575885858859588605886158862588635886458865588665886758868588695887058871588725887358874588755887658877588785887958880588815888258883588845888558886588875888858889588905889158892588935889458895588965889758898588995890058901589025890358904589055890658907589085890958910589115891258913589145891558916589175891858919589205892158922589235892458925589265892758928589295893058931589325893358934589355893658937589385893958940589415894258943589445894558946589475894858949589505895158952589535895458955589565895758958589595896058961589625896358964589655896658967589685896958970589715897258973589745897558976589775897858979589805898158982589835898458985589865898758988589895899058991589925899358994589955899658997589985899959000590015900259003590045900559006590075900859009590105901159012590135901459015590165901759018590195902059021590225902359024590255902659027590285902959030590315903259033590345903559036590375903859039590405904159042590435904459045590465904759048590495905059051590525905359054590555905659057590585905959060590615906259063590645906559066590675906859069590705907159072590735907459075590765907759078590795908059081590825908359084590855908659087590885908959090590915909259093590945909559096590975909859099591005910159102591035910459105591065910759108591095911059111591125911359114591155911659117591185911959120591215912259123591245912559126591275912859129591305913159132591335913459135591365913759138591395914059141591425914359144591455914659147591485914959150591515915259153591545915559156591575915859159591605916159162591635916459165591665916759168591695917059171591725917359174591755917659177591785917959180591815918259183591845918559186591875918859189591905919159192591935919459195591965919759198591995920059201592025920359204592055920659207592085920959210592115921259213592145921559216592175921859219592205922159222592235922459225592265922759228592295923059231592325923359234592355923659237592385923959240592415924259243592445924559246592475924859249592505925159252592535925459255592565925759258592595926059261592625926359264592655926659267592685926959270592715927259273592745927559276592775927859279592805928159282592835928459285592865928759288592895929059291592925929359294592955929659297592985929959300593015930259303593045930559306593075930859309593105931159312593135931459315593165931759318593195932059321593225932359324593255932659327593285932959330593315933259333593345933559336593375933859339593405934159342593435934459345593465934759348593495935059351593525935359354593555935659357593585935959360593615936259363593645936559366593675936859369593705937159372593735937459375593765937759378593795938059381593825938359384593855938659387593885938959390593915939259393593945939559396593975939859399594005940159402594035940459405594065940759408594095941059411594125941359414594155941659417594185941959420594215942259423594245942559426594275942859429594305943159432594335943459435594365943759438594395944059441594425944359444594455944659447594485944959450594515945259453594545945559456594575945859459594605946159462594635946459465594665946759468594695947059471594725947359474594755947659477594785947959480594815948259483594845948559486594875948859489594905949159492594935949459495594965949759498594995950059501595025950359504595055950659507595085950959510595115951259513595145951559516595175951859519595205952159522595235952459525595265952759528595295953059531595325953359534595355953659537595385953959540595415954259543595445954559546595475954859549595505955159552595535955459555595565955759558595595956059561595625956359564595655956659567595685956959570595715957259573595745957559576595775957859579595805958159582595835958459585595865958759588595895959059591595925959359594595955959659597595985959959600596015960259603596045960559606596075960859609596105961159612596135961459615596165961759618596195962059621596225962359624596255962659627596285962959630596315963259633596345963559636596375963859639596405964159642596435964459645596465964759648596495965059651596525965359654596555965659657596585965959660596615966259663596645966559666596675966859669596705967159672596735967459675596765967759678596795968059681596825968359684596855968659687596885968959690596915969259693596945969559696596975969859699597005970159702597035970459705597065970759708597095971059711597125971359714597155971659717597185971959720597215972259723597245972559726597275972859729597305973159732597335973459735597365973759738597395974059741597425974359744597455974659747597485974959750597515975259753597545975559756597575975859759597605976159762597635976459765597665976759768597695977059771597725977359774597755977659777597785977959780597815978259783597845978559786597875978859789597905979159792597935979459795597965979759798597995980059801598025980359804598055980659807598085980959810598115981259813598145981559816598175981859819598205982159822598235982459825598265982759828598295983059831598325983359834598355983659837598385983959840598415984259843598445984559846598475984859849598505985159852598535985459855598565985759858598595986059861598625986359864598655986659867598685986959870598715987259873598745987559876598775987859879598805988159882598835988459885598865988759888598895989059891598925989359894598955989659897598985989959900599015990259903599045990559906599075990859909599105991159912599135991459915599165991759918599195992059921599225992359924599255992659927599285992959930599315993259933599345993559936599375993859939599405994159942599435994459945599465994759948599495995059951599525995359954599555995659957599585995959960599615996259963599645996559966599675996859969599705997159972599735997459975599765997759978599795998059981599825998359984599855998659987599885998959990599915999259993599945999559996599975999859999600006000160002600036000460005600066000760008600096001060011600126001360014600156001660017600186001960020600216002260023600246002560026600276002860029600306003160032600336003460035600366003760038600396004060041600426004360044600456004660047600486004960050600516005260053600546005560056600576005860059600606006160062600636006460065600666006760068600696007060071600726007360074600756007660077600786007960080600816008260083600846008560086600876008860089600906009160092600936009460095600966009760098600996010060101601026010360104601056010660107601086010960110601116011260113601146011560116601176011860119601206012160122601236012460125601266012760128601296013060131601326013360134601356013660137601386013960140601416014260143601446014560146601476014860149601506015160152601536015460155601566015760158601596016060161601626016360164601656016660167601686016960170601716017260173601746017560176601776017860179601806018160182601836018460185601866018760188601896019060191601926019360194601956019660197601986019960200602016020260203602046020560206602076020860209602106021160212602136021460215602166021760218602196022060221602226022360224602256022660227602286022960230602316023260233602346023560236602376023860239602406024160242602436024460245602466024760248602496025060251602526025360254602556025660257602586025960260602616026260263602646026560266602676026860269602706027160272602736027460275602766027760278602796028060281602826028360284602856028660287602886028960290602916029260293602946029560296602976029860299603006030160302603036030460305603066030760308603096031060311603126031360314603156031660317603186031960320603216032260323603246032560326603276032860329603306033160332603336033460335603366033760338603396034060341603426034360344603456034660347603486034960350603516035260353603546035560356603576035860359603606036160362603636036460365603666036760368603696037060371603726037360374603756037660377603786037960380603816038260383603846038560386603876038860389603906039160392603936039460395603966039760398603996040060401604026040360404604056040660407604086040960410604116041260413604146041560416604176041860419604206042160422604236042460425604266042760428604296043060431604326043360434604356043660437604386043960440604416044260443604446044560446604476044860449604506045160452604536045460455604566045760458604596046060461604626046360464604656046660467604686046960470604716047260473604746047560476604776047860479604806048160482604836048460485604866048760488604896049060491604926049360494604956049660497604986049960500605016050260503605046050560506605076050860509605106051160512605136051460515605166051760518605196052060521605226052360524605256052660527605286052960530605316053260533605346053560536605376053860539605406054160542605436054460545605466054760548605496055060551605526055360554605556055660557605586055960560605616056260563605646056560566605676056860569605706057160572605736057460575605766057760578605796058060581605826058360584605856058660587605886058960590605916059260593605946059560596605976059860599606006060160602606036060460605606066060760608606096061060611606126061360614606156061660617606186061960620606216062260623606246062560626606276062860629606306063160632606336063460635606366063760638606396064060641606426064360644606456064660647606486064960650606516065260653606546065560656606576065860659606606066160662606636066460665606666066760668606696067060671606726067360674606756067660677606786067960680606816068260683606846068560686606876068860689606906069160692606936069460695606966069760698606996070060701607026070360704607056070660707607086070960710607116071260713607146071560716607176071860719607206072160722607236072460725607266072760728607296073060731607326073360734607356073660737607386073960740607416074260743607446074560746607476074860749607506075160752607536075460755607566075760758607596076060761607626076360764607656076660767607686076960770607716077260773607746077560776607776077860779607806078160782607836078460785607866078760788607896079060791607926079360794607956079660797607986079960800608016080260803608046080560806608076080860809608106081160812608136081460815608166081760818608196082060821608226082360824608256082660827608286082960830608316083260833608346083560836608376083860839608406084160842608436084460845608466084760848608496085060851608526085360854608556085660857608586085960860608616086260863608646086560866608676086860869608706087160872608736087460875608766087760878608796088060881608826088360884608856088660887608886088960890608916089260893608946089560896608976089860899609006090160902609036090460905609066090760908609096091060911609126091360914609156091660917609186091960920609216092260923609246092560926609276092860929609306093160932609336093460935609366093760938609396094060941609426094360944609456094660947609486094960950609516095260953609546095560956609576095860959609606096160962609636096460965609666096760968609696097060971609726097360974609756097660977609786097960980609816098260983 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>MailKit</name>
- </assembly>
- <members>
- <member name="T:MailKit.Net.Imap.ImapClient">
- <summary>
- An IMAP client that can be used to retrieve messages from a server.
- </summary>
- <remarks>
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> class supports both the "imap" and "imaps"
- protocols. The "imap" protocol makes a clear-text connection to the IMAP
- server and does not use SSL or TLS unless the IMAP server supports the
- <a href="https://tools.ietf.org/html/rfc3501#section-6.2.1">STARTTLS</a> extension.
- The "imaps" protocol, however, connects to the IMAP server using an
- SSL-wrapped connection.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.CompressAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable compression over the IMAP connection.
- </summary>
- <remarks>
- <para>Asynchronously enables compression over the IMAP connection.</para>
- <para>If the IMAP server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension,
- it is possible at any point after connecting to enable compression to reduce network
- bandwidth usage. Ideally, this method should be called before authenticating.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Compression must be enabled before a folder has been selected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the COMPRESS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the COMPRESS command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.EnableQuickResyncAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable the QRESYNC feature.
- </summary>
- <remarks>
- <para>Enables the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a> feature.</para>
- <para>The QRESYNC extension improves resynchronization performance of folders by
- querying the IMAP server for a list of changes when the folder is opened using the
- <see cref="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
- method.</para>
- <para>If this feature is enabled, the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is replaced
- with the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event.</para>
- <para>This method needs to be called immediately after calling one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a> methods, before
- opening any folders.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Quick resynchronization needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QRESYNC extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ENABLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.EnableUTF8Async(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable the UTF8=ACCEPT extension.
- </summary>
- <remarks>
- Enables the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- UTF8=ACCEPT needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the UTF8=ACCEPT extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ENABLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.IdentifyAsync(MailKit.Net.Imap.ImapImplementation,System.Threading.CancellationToken)">
- <summary>
- Asynchronously identify the client implementation to the server and obtain the server implementation details.
- </summary>
- <remarks>
- <para>Passes along the client implementation details to the server while also obtaining implementation
- details from the server.</para>
- <para>If the <paramref name="clientImplementation"/> is <c>null</c> or no properties have been set, no
- identifying information will be sent to the server.</para>
- <note type="security">
- <para>Security Implications</para>
- <para>This command has the danger of violating the privacy of users if misused. Clients should
- notify users that they send the ID command.</para>
- <para>It is highly desirable that implementations provide a method of disabling ID support, perhaps by
- not calling this method at all, or by passing <c>null</c> as the <paramref name="clientImplementation"/>
- argument.</para>
- <para>Implementors must exercise extreme care in adding properties to the <paramref name="clientImplementation"/>.
- Some properties, such as a processor ID number, Ethernet address, or other unique (or mostly unique) identifier
- would allow tracking of users in ways that violate user privacy expectations and may also make it easier for
- attackers to exploit security holes in the client.</para>
- </note>
- </remarks>
- <returns>The implementation details of the server if available; otherwise, <c>null</c>.</returns>
- <param name="clientImplementation">The client implementation.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ID extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ID command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the IMAP server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then LOGIN command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The text encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified IMAP server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified IMAP or IMAP/S server.</para>
- <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
- <paramref name="options"/> parameter is used to determine the default port to
- connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
- is <c>993</c>. All other values will use a default port of <c>143</c>.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>993</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
- populated.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the IMAP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified IMAP or IMAP/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified IMAP or IMAP/S server using
- the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>993</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the IMAP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified IMAP or IMAP/S server using the provided stream.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified IMAP or IMAP/S server using
- the provided stream.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>993</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the IMAP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a <c>LOGOUT</c> command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="quit">If set to <c>true</c>, a <c>LOGOUT</c> command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.NoOpAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously ping the IMAP server to keep the connection alive.
- </summary>
- <remarks>
- <para>The <c>NOOP</c> command is typically used to keep the connection with the IMAP server
- alive. When a client goes too long (typically 30 minutes) without sending any commands to the
- IMAP server, the IMAP server will close the connection with the client, forcing the client to
- reconnect before it can send any more commands.</para>
- <para>The <c>NOOP</c> command also provides a great way for a client to check for new
- messages.</para>
- <para>When the IMAP server receives a <c>NOOP</c> command, it will reply to the client with a
- list of pending updates such as <c>EXISTS</c> and <c>RECENT</c> counts on the currently
- selected folder. To receive these notifications, subscribe to the
- <see cref="E:MailKit.MailFolder.CountChanged"/> and <see cref="E:MailKit.MailFolder.RecentChanged"/> events,
- respectively.</para>
- <para>For more information about the <c>NOOP</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.1.2">rfc3501</a>.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOOP command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.IdleAsync(System.Threading.CancellationToken,System.Threading.CancellationToken)">
- <summary>
- Asynchronously toggle the <see cref="T:MailKit.Net.Imap.ImapClient"/> into the IDLE state.
- </summary>
- <remarks>
- <para>When a client enters the IDLE state, the IMAP server will send
- events to the client as they occur on the selected folder. These events
- may include notifications of new messages arriving, expunge notifications,
- flag changes, etc.</para>
- <para>Due to the nature of the IDLE command, a folder must be selected
- before a client can enter into the IDLE state. This can be done by
- opening a folder using
- <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- or any of the other variants.</para>
- <para>While the IDLE command is running, no other commands may be issued until the
- <paramref name="doneToken"/> is cancelled.</para>
- <note type="note">It is especially important to cancel the <paramref name="doneToken"/>
- before cancelling the <paramref name="cancellationToken"/> when using SSL or TLS due to
- the fact that <see cref="T:System.Net.Security.SslStream"/> cannot be polled.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="doneToken">The cancellation token used to return to the non-idle state.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="doneToken"/> must be cancellable (i.e. <see cref="P:System.Threading.CancellationToken.None"/> cannot be used).
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- A <see cref="T:MailKit.Net.Imap.ImapFolder"/> has not been opened.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the IDLE extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the IDLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.NotifyAsync(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)">
- <summary>
- Asynchronously request the specified notification events from the IMAP server.
- </summary>
- <remarks>
- <para>The <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> command is used to expand
- which notifications the client wishes to be notified about, including status notifications
- about folders other than the currently selected folder. It can also be used to automatically
- FETCH information about new messages that have arrived in the currently selected folder.</para>
- <para>This, combined with <see cref="M:MailKit.Net.Imap.ImapClient.IdleAsync(System.Threading.CancellationToken,System.Threading.CancellationToken)"/>,
- can be used to get instant notifications for changes to any of the specified folders.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="status"><c>true</c> if the server should immediately notify the client of the
- selected folder's status; otherwise, <c>false</c>.</param>
- <param name="eventGroups">The specific event groups that the client would like to receive notifications for.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="eventGroups"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="eventGroups"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- One or more <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> is invalid.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.DisableNotifyAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously disable any previously requested notification events from the IMAP server.
- </summary>
- <remarks>
- Disables any notification events requested in a prior call to
- <see cref="M:MailKit.Net.Imap.ImapClient.NotifyAsync(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)"/>.
- request.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetFoldersAsync(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The namespace folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the LIST or LSUB command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetFolderAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the folder for the specified path.
- </summary>
- <remarks>
- Gets the folder for the specified path.
- </remarks>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the IDLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA or METADATA-SERVER extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA or METADATA-SERVER extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA or METADATA-SERVER extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapClient"/> class.
- </summary>
- <remarks>
- Before you can retrieve messages with the <see cref="T:MailKit.Net.Imap.ImapClient"/>, you must first
- call one of the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
- methods and then authenticate with the one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
- methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapClient"/> class.
- </summary>
- <remarks>
- Before you can retrieve messages with the <see cref="T:MailKit.Net.Imap.ImapClient"/>, you must first
- call one of the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
- methods and then authenticate with the one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
- methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="ProtocolLogger"/>
- </example>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the IMAP server.
- </summary>
- <remarks>
- <para>Gets an object that can be used to synchronize access to the IMAP server.</para>
- <para>When using the non-Async methods from multiple threads, it is important to lock the
- <see cref="P:MailKit.Net.Imap.ImapClient.SyncRoot"/> object for thread safety when using the synchronous methods.</para>
- </remarks>
- <value>The lock object.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.Protocol">
- <summary>
- Get the protocol supported by the message service.
- </summary>
- <remarks>
- Gets the protocol supported by the message service.
- </remarks>
- <value>The protocol.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.Capabilities">
- <summary>
- Get the capabilities supported by the IMAP server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection has been made via one of
- the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a> methods and may
- change as a side-effect of calling one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
- methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The capabilities.</value>
- <exception cref="T:System.ArgumentException">
- Capabilities cannot be enabled, they may only be disabled.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.AppendLimit">
- <summary>
- Gets the maximum size of a message that can be appended to a folder.
- </summary>
- <remarks>
- <para>Gets the maximum size of a message, in bytes, that can be appended to a folder.</para>
- <note type="note">If the value is not set, then the limit is unspecified.</note>
- </remarks>
- <value>The append limit.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.InternationalizationLevel">
- <summary>
- Gets the internationalization level supported by the IMAP server.
- </summary>
- <remarks>
- <para>Gets the internationalization level supported by the IMAP server.</para>
- <para>For more information, see
- <a href="https://tools.ietf.org/html/rfc5255#section-4">section 4 of rfc5255</a>.</para>
- </remarks>
- <value>The internationalization level.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.Rights">
- <summary>
- Get the access rights supported by the IMAP server.
- </summary>
- <remarks>
- These rights are additional rights supported by the IMAP server beyond the standard rights
- defined in <a href="https://tools.ietf.org/html/rfc4314#section-2.1">section 2.1 of rfc4314</a>
- and will not be populated until the client is successfully connected.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The rights.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.CreateImapFolder(MailKit.Net.Imap.ImapFolderConstructorArgs)">
- <summary>
- Instantiate a new <see cref="T:MailKit.Net.Imap.ImapFolder"/>.
- </summary>
- <remarks>
- <para>Creates a new <see cref="T:MailKit.Net.Imap.ImapFolder"/> instance.</para>
- <note type="note">This method's purpose is to allow subclassing <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</note>
- </remarks>
- <returns>The IMAP folder instance.</returns>
- <param name="args">The constructior arguments.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="args"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Compress(System.Threading.CancellationToken)">
- <summary>
- Enable compression over the IMAP connection.
- </summary>
- <remarks>
- <para>Enables compression over the IMAP connection.</para>
- <para>If the IMAP server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension,
- it is possible at any point after connecting to enable compression to reduce network
- bandwidth usage. Ideally, this method should be called before authenticating.</para>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Compression must be enabled before a folder has been selected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the COMPRESS command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)">
- <summary>
- Enable the QRESYNC feature.
- </summary>
- <remarks>
- <para>Enables the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a> feature.</para>
- <para>The QRESYNC extension improves resynchronization performance of folders by
- querying the IMAP server for a list of changes when the folder is opened using the
- <see cref="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
- method.</para>
- <para>If this feature is enabled, the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is replaced
- with the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event.</para>
- <para>This method needs to be called immediately after calling one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a> methods, before
- opening any folders.</para>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Quick resynchronization needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QRESYNC extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ENABLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.EnableUTF8(System.Threading.CancellationToken)">
- <summary>
- Enable the UTF8=ACCEPT extension.
- </summary>
- <remarks>
- Enables the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- UTF8=ACCEPT needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the UTF8=ACCEPT extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ENABLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Identify(MailKit.Net.Imap.ImapImplementation,System.Threading.CancellationToken)">
- <summary>
- Identify the client implementation to the server and obtain the server implementation details.
- </summary>
- <remarks>
- <para>Passes along the client implementation details to the server while also obtaining implementation
- details from the server.</para>
- <para>If the <paramref name="clientImplementation"/> is <c>null</c> or no properties have been set, no
- identifying information will be sent to the server.</para>
- <note type="security">
- <para>Security Implications</para>
- <para>This command has the danger of violating the privacy of users if misused. Clients should
- notify users that they send the ID command.</para>
- <para>It is highly desirable that implementations provide a method of disabling ID support, perhaps by
- not calling this method at all, or by passing <c>null</c> as the <paramref name="clientImplementation"/>
- argument.</para>
- <para>Implementors must exercise extreme care in adding properties to the <paramref name="clientImplementation"/>.
- Some properties, such as a processor ID number, Ethernet address, or other unique (or mostly unique) identifier
- would allow tracking of users in ways that violate user privacy expectations and may also make it easier for
- attackers to exploit security holes in the client.</para>
- </note>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <returns>The implementation details of the server if available; otherwise, <c>null</c>.</returns>
- <param name="clientImplementation">The client implementation.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ID extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ID command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms">
- <summary>
- Get the authentication mechanisms supported by the IMAP server.
- </summary>
- <remarks>
- <para>The authentication mechanisms are queried as part of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
- method.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> hash set
- before authenticating.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.ThreadingAlgorithms">
- <summary>
- Get the threading algorithms supported by the IMAP server.
- </summary>
- <remarks>
- The threading algorithms are queried as part of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
- and <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The supported threading algorithms.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.Timeout">
- <summary>
- Get or set the timeout for network streaming operations, in milliseconds.
- </summary>
- <remarks>
- Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
- and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
- </remarks>
- <value>The timeout in milliseconds.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.IsConnected">
- <summary>
- Get whether or not the client is currently connected to an IMAP server.
- </summary>
- <remarks>
- <para>The <see cref="P:MailKit.Net.Imap.ImapClient.IsConnected"/> state is set to <c>true</c> immediately after
- one of the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
- methods succeeds and is not set back to <c>false</c> until either the client
- is disconnected via <see cref="M:MailKit.Net.Imap.ImapClient.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until an
- <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> is thrown while attempting to read or write to
- the underlying network socket.</para>
- <para>When an <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> is caught, the connection state of the
- <see cref="T:MailKit.Net.Imap.ImapClient"/> should be checked before continuing.</para>
- </remarks>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.IsSecure">
- <summary>
- Get whether or not the connection is secure (typically via SSL or TLS).
- </summary>
- <remarks>
- Gets whether or not the connection is secure (typically via SSL or TLS).
- </remarks>
- <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.IsAuthenticated">
- <summary>
- Get whether or not the client is currently authenticated with the IMAP server.
- </summary>
- <remarks>
- <para>Gets whether or not the client is currently authenticated with the IMAP server.</para>
- <para>To authenticate with the IMAP server, use one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
- methods.</para>
- </remarks>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.IsIdle">
- <summary>
- Get whether or not the client is currently in the IDLE state.
- </summary>
- <remarks>
- Gets whether or not the client is currently in the IDLE state.
- </remarks>
- <value><c>true</c> if an IDLE command is active; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the IMAP server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then LOGIN command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <param name="encoding">The text encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified IMAP server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified IMAP or IMAP/S server.</para>
- <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
- <paramref name="options"/> parameter is used to determine the default port to
- connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
- is <c>993</c>. All other values will use a default port of <c>143</c>.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>993</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
- populated.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the IMAP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified IMAP or IMAP/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified IMAP or IMAP/S server using
- the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>993</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the IMAP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified IMAP or IMAP/S server using the provided stream.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified IMAP or IMAP/S server using
- the provided stream.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>993</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the IMAP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Disconnect(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a <c>LOGOUT</c> command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <param name="quit">If set to <c>true</c>, a <c>LOGOUT</c> command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.NoOp(System.Threading.CancellationToken)">
- <summary>
- Ping the IMAP server to keep the connection alive.
- </summary>
- <remarks>
- <para>The <c>NOOP</c> command is typically used to keep the connection with the IMAP server
- alive. When a client goes too long (typically 30 minutes) without sending any commands to the
- IMAP server, the IMAP server will close the connection with the client, forcing the client to
- reconnect before it can send any more commands.</para>
- <para>The <c>NOOP</c> command also provides a great way for a client to check for new
- messages.</para>
- <para>When the IMAP server receives a <c>NOOP</c> command, it will reply to the client with a
- list of pending updates such as <c>EXISTS</c> and <c>RECENT</c> counts on the currently
- selected folder. To receive these notifications, subscribe to the
- <see cref="E:MailKit.MailFolder.CountChanged"/> and <see cref="E:MailKit.MailFolder.RecentChanged"/> events,
- respectively.</para>
- <para>For more information about the <c>NOOP</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.1.2">rfc3501</a>.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOOP command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Idle(System.Threading.CancellationToken,System.Threading.CancellationToken)">
- <summary>
- Toggle the <see cref="T:MailKit.Net.Imap.ImapClient"/> into the IDLE state.
- </summary>
- <remarks>
- <para>When a client enters the IDLE state, the IMAP server will send
- events to the client as they occur on the selected folder. These events
- may include notifications of new messages arriving, expunge notifications,
- flag changes, etc.</para>
- <para>Due to the nature of the IDLE command, a folder must be selected
- before a client can enter into the IDLE state. This can be done by
- opening a folder using
- <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- or any of the other variants.</para>
- <para>While the IDLE command is running, no other commands may be issued until the
- <paramref name="doneToken"/> is cancelled.</para>
- <note type="note">It is especially important to cancel the <paramref name="doneToken"/>
- before cancelling the <paramref name="cancellationToken"/> when using SSL or TLS due to
- the fact that <see cref="T:System.Net.Security.SslStream"/> cannot be polled.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- <param name="doneToken">The cancellation token used to return to the non-idle state.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="doneToken"/> must be cancellable (i.e. <see cref="P:System.Threading.CancellationToken.None"/> cannot be used).
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- A <see cref="T:MailKit.Net.Imap.ImapFolder"/> has not been opened.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the IDLE extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the IDLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Notify(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)">
- <summary>
- Request the specified notification events from the IMAP server.
- </summary>
- <remarks>
- <para>The <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> command is used to expand
- which notifications the client wishes to be notified about, including status notifications
- about folders other than the currently selected folder. It can also be used to automatically
- FETCH information about new messages that have arrived in the currently selected folder.</para>
- <para>This, combined with <see cref="M:MailKit.Net.Imap.ImapClient.Idle(System.Threading.CancellationToken,System.Threading.CancellationToken)"/>,
- can be used to get instant notifications for changes to any of the specified folders.</para>
- </remarks>
- <param name="status"><c>true</c> if the server should immediately notify the client of the
- selected folder's status; otherwise, <c>false</c>.</param>
- <param name="eventGroups">The specific event groups that the client would like to receive notifications for.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="eventGroups"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="eventGroups"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- One or more <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> is invalid.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.DisableNotify(System.Threading.CancellationToken)">
- <summary>
- Disable any previously requested notification events from the IMAP server.
- </summary>
- <remarks>
- Disables any notification events requested in a prior call to
- <see cref="M:MailKit.Net.Imap.ImapClient.Notify(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)"/>.
- request.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.PersonalNamespaces">
- <summary>
- Get the personal namespaces.
- </summary>
- <remarks>
- The personal folder namespaces contain a user's personal mailbox folders.
- </remarks>
- <value>The personal namespaces.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.SharedNamespaces">
- <summary>
- Get the shared namespaces.
- </summary>
- <remarks>
- The shared folder namespaces contain mailbox folders that are shared with the user.
- </remarks>
- <value>The shared namespaces.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.OtherNamespaces">
- <summary>
- Get the other namespaces.
- </summary>
- <remarks>
- The other folder namespaces contain other mailbox folders.
- </remarks>
- <value>The other namespaces.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.SupportsQuotas">
- <summary>
- Get whether or not the mail store supports quotas.
- </summary>
- <remarks>
- Gets whether or not the mail store supports quotas.
- </remarks>
- <value><c>true</c> if the mail store supports quotas; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.Inbox">
- <summary>
- Get the Inbox folder.
- </summary>
- <remarks>
- <para>The Inbox folder is the default folder and always exists on the server.</para>
- <note type="note">This property will only be available after the client has been authenticated.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <value>The Inbox folder.</value>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetFolder(MailKit.SpecialFolder)">
- <summary>
- Get the specified special folder.
- </summary>
- <remarks>
- Not all IMAP servers support special folders. Only IMAP servers
- supporting the <see cref="F:MailKit.Net.Imap.ImapCapabilities.SpecialUse"/> or
- <see cref="F:MailKit.Net.Imap.ImapCapabilities.XList"/> extensions may have
- special folders.
- </remarks>
- <returns>The folder if available; otherwise <c>null</c>.</returns>
- <param name="folder">The type of special folder.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="folder"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the SPECIAL-USE nor XLIST extensions.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetFolder(MailKit.FolderNamespace)">
- <summary>
- Get the folder for the specified namespace.
- </summary>
- <remarks>
- Gets the folder for the specified namespace.
- </remarks>
- <returns>The folder.</returns>
- <param name="namespace">The namespace.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetFolders(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The namespace folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the LIST or LSUB command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetFolder(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the folder for the specified path.
- </summary>
- <remarks>
- Gets the folder for the specified path.
- </remarks>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the IDLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA or METADATA-SERVER extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA or METADATA-SERVER extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Sets the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA or METADATA-SERVER extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Imap.ImapClient"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Imap.ImapClient"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Net.Imap.IImapClient">
- <summary>
- An interface for an IMAP client.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Imap.ImapClient"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Imap.IImapClient.Capabilities">
- <summary>
- Get the capabilities supported by the IMAP server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection has been made via one of
- the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a> methods and may
- change as a side-effect of calling one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
- methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The capabilities.</value>
- <exception cref="T:System.ArgumentException">
- Capabilities cannot be enabled, they may only be disabled.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.IImapClient.AppendLimit">
- <summary>
- Gets the maximum size of a message that can be appended to a folder.
- </summary>
- <remarks>
- <para>Gets the maximum size of a message, in bytes, that can be appended to a folder.</para>
- <note type="note">If the value is not set, then the limit is unspecified.</note>
- </remarks>
- <value>The append limit.</value>
- </member>
- <member name="P:MailKit.Net.Imap.IImapClient.InternationalizationLevel">
- <summary>
- Gets the internationalization level supported by the IMAP server.
- </summary>
- <remarks>
- <para>Gets the internationalization level supported by the IMAP server.</para>
- <para>For more information, see
- <a href="https://tools.ietf.org/html/rfc5255#section-4">section 4 of rfc5255</a>.</para>
- </remarks>
- <value>The internationalization level.</value>
- </member>
- <member name="P:MailKit.Net.Imap.IImapClient.Rights">
- <summary>
- Get the access rights supported by the IMAP server.
- </summary>
- <remarks>
- These rights are additional rights supported by the IMAP server beyond the standard rights
- defined in <a href="https://tools.ietf.org/html/rfc4314#section-2.1">section 2.1 of rfc4314</a>
- and will not be populated until the client is successfully connected.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The rights.</value>
- </member>
- <member name="P:MailKit.Net.Imap.IImapClient.IsIdle">
- <summary>
- Get whether or not the client is currently in the IDLE state.
- </summary>
- <remarks>
- Gets whether or not the client is currently in the IDLE state.
- </remarks>
- <value><c>true</c> if an IDLE command is active; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.Compress(System.Threading.CancellationToken)">
- <summary>
- Enable compression over the IMAP connection.
- </summary>
- <remarks>
- <para>Enables compression over the IMAP connection.</para>
- <para>If the IMAP server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension,
- it is possible at any point after connecting to enable compression to reduce network
- bandwidth usage. Ideally, this method should be called before authenticating.</para>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Compression must be enabled before a folder has been selected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the COMPRESS command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.CompressAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable compression over the IMAP connection.
- </summary>
- <remarks>
- <para>Asynchronously enables compression over the IMAP connection.</para>
- <para>If the IMAP server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension,
- it is possible at any point after connecting to enable compression to reduce network
- bandwidth usage. Ideally, this method should be called before authenticating.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Compression must be enabled before a folder has been selected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the COMPRESS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the COMPRESS command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.EnableUTF8(System.Threading.CancellationToken)">
- <summary>
- Enable the UTF8=ACCEPT extension.
- </summary>
- <remarks>
- Enables the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- UTF8=ACCEPT needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the UTF8=ACCEPT extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ENABLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.EnableUTF8Async(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable the UTF8=ACCEPT extension.
- </summary>
- <remarks>
- Enables the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- UTF8=ACCEPT needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the UTF8=ACCEPT extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ENABLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.Identify(MailKit.Net.Imap.ImapImplementation,System.Threading.CancellationToken)">
- <summary>
- Identify the client implementation to the server and obtain the server implementation details.
- </summary>
- <remarks>
- <para>Passes along the client implementation details to the server while also obtaining implementation
- details from the server.</para>
- <para>If the <paramref name="clientImplementation"/> is <c>null</c> or no properties have been set, no
- identifying information will be sent to the server.</para>
- <note type="security">
- <para>Security Implications</para>
- <para>This command has the danger of violating the privacy of users if misused. Clients should
- notify users that they send the ID command.</para>
- <para>It is highly desirable that implementations provide a method of disabling ID support, perhaps by
- not calling this method at all, or by passing <c>null</c> as the <paramref name="clientImplementation"/>
- argument.</para>
- <para>Implementors must exercise extreme care in adding properties to the <paramref name="clientImplementation"/>.
- Some properties, such as a processor ID number, Ethernet address, or other unique (or mostly unique) identifier
- would allow tracking of users in ways that violate user privacy expectations and may also make it easier for
- attackers to exploit security holes in the client.</para>
- </note>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <returns>The implementation details of the server if available; otherwise, <c>null</c>.</returns>
- <param name="clientImplementation">The client implementation.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ID extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ID command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.IdentifyAsync(MailKit.Net.Imap.ImapImplementation,System.Threading.CancellationToken)">
- <summary>
- Asynchronously identify the client implementation to the server and obtain the server implementation details.
- </summary>
- <remarks>
- <para>Passes along the client implementation details to the server while also obtaining implementation
- details from the server.</para>
- <para>If the <paramref name="clientImplementation"/> is <c>null</c> or no properties have been set, no
- identifying information will be sent to the server.</para>
- <note type="security">
- <para>Security Implications</para>
- <para>This command has the danger of violating the privacy of users if misused. Clients should
- notify users that they send the ID command.</para>
- <para>It is highly desirable that implementations provide a method of disabling ID support, perhaps by
- not calling this method at all, or by passing <c>null</c> as the <paramref name="clientImplementation"/>
- argument.</para>
- <para>Implementors must exercise extreme care in adding properties to the <paramref name="clientImplementation"/>.
- Some properties, such as a processor ID number, Ethernet address, or other unique (or mostly unique) identifier
- would allow tracking of users in ways that violate user privacy expectations and may also make it easier for
- attackers to exploit security holes in the client.</para>
- </note>
- </remarks>
- <returns>The implementation details of the server if available; otherwise, <c>null</c>.</returns>
- <param name="clientImplementation">The client implementation.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ID extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ID command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.Idle(System.Threading.CancellationToken,System.Threading.CancellationToken)">
- <summary>
- Toggle the <see cref="T:MailKit.Net.Imap.ImapClient"/> into the IDLE state.
- </summary>
- <remarks>
- <para>When a client enters the IDLE state, the IMAP server will send
- events to the client as they occur on the selected folder. These events
- may include notifications of new messages arriving, expunge notifications,
- flag changes, etc.</para>
- <para>Due to the nature of the IDLE command, a folder must be selected
- before a client can enter into the IDLE state. This can be done by
- opening a folder using
- <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- or any of the other variants.</para>
- <para>While the IDLE command is running, no other commands may be issued until the
- <paramref name="doneToken"/> is cancelled.</para>
- <note type="note">It is especially important to cancel the <paramref name="doneToken"/>
- before cancelling the <paramref name="cancellationToken"/> when using SSL or TLS due to
- the fact that <see cref="T:System.Net.Security.SslStream"/> cannot be polled.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- <param name="doneToken">The cancellation token used to return to the non-idle state.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="doneToken"/> must be cancellable (i.e. <see cref="P:System.Threading.CancellationToken.None"/> cannot be used).
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- A <see cref="T:MailKit.Net.Imap.ImapFolder"/> has not been opened.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the IDLE extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the IDLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.IdleAsync(System.Threading.CancellationToken,System.Threading.CancellationToken)">
- <summary>
- Asynchronously toggle the <see cref="T:MailKit.Net.Imap.ImapClient"/> into the IDLE state.
- </summary>
- <remarks>
- <para>When a client enters the IDLE state, the IMAP server will send
- events to the client as they occur on the selected folder. These events
- may include notifications of new messages arriving, expunge notifications,
- flag changes, etc.</para>
- <para>Due to the nature of the IDLE command, a folder must be selected
- before a client can enter into the IDLE state. This can be done by
- opening a folder using
- <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- or any of the other variants.</para>
- <para>While the IDLE command is running, no other commands may be issued until the
- <paramref name="doneToken"/> is cancelled.</para>
- <note type="note">It is especially important to cancel the <paramref name="doneToken"/>
- before cancelling the <paramref name="cancellationToken"/> when using SSL or TLS due to
- the fact that <see cref="T:System.Net.Security.SslStream"/> cannot be polled.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="doneToken">The cancellation token used to return to the non-idle state.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="doneToken"/> must be cancellable (i.e. <see cref="P:System.Threading.CancellationToken.None"/> cannot be used).
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- A <see cref="T:MailKit.Net.Imap.ImapFolder"/> has not been opened.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the IDLE extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the IDLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.Notify(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)">
- <summary>
- Request the specified notification events from the IMAP server.
- </summary>
- <remarks>
- <para>The <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> command is used to expand
- which notifications the client wishes to be notified about, including status notifications
- about folders other than the currently selected folder. It can also be used to automatically
- FETCH information about new messages that have arrived in the currently selected folder.</para>
- <para>This, combined with <see cref="M:MailKit.Net.Imap.IImapClient.Idle(System.Threading.CancellationToken,System.Threading.CancellationToken)"/>,
- can be used to get instant notifications for changes to any of the specified folders.</para>
- </remarks>
- <param name="status"><c>true</c> if the server should immediately notify the client of the
- selected folder's status; otherwise, <c>false</c>.</param>
- <param name="eventGroups">The specific event groups that the client would like to receive notifications for.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="eventGroups"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="eventGroups"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- One or more <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> is invalid.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.NotifyAsync(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)">
- <summary>
- Asynchronously request the specified notification events from the IMAP server.
- </summary>
- <remarks>
- <para>The <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> command is used to expand
- which notifications the client wishes to be notified about, including status notifications
- about folders other than the currently selected folder. It can also be used to automatically
- FETCH information about new messages that have arrived in the currently selected folder.</para>
- <para>This, combined with <see cref="M:MailKit.Net.Imap.IImapClient.IdleAsync(System.Threading.CancellationToken,System.Threading.CancellationToken)"/>,
- can be used to get instant notifications for changes to any of the specified folders.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="status"><c>true</c> if the server should immediately notify the client of the
- selected folder's status; otherwise, <c>false</c>.</param>
- <param name="eventGroups">The specific event groups that the client would like to receive notifications for.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="eventGroups"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="eventGroups"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- One or more <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> is invalid.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.DisableNotify(System.Threading.CancellationToken)">
- <summary>
- Disable any previously requested notification events from the IMAP server.
- </summary>
- <remarks>
- Disables any notification events requested in a prior call to
- <see cref="M:MailKit.Net.Imap.IImapClient.Notify(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)"/>.
- request.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.DisableNotifyAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously disable any previously requested notification events from the IMAP server.
- </summary>
- <remarks>
- Disables any notification events requested in a prior call to
- <see cref="M:MailKit.Net.Imap.IImapClient.NotifyAsync(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)"/>.
- request.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="T:MailKit.Net.Imap.IImapFolder">
- <summary>
- An interface for an IMAP folder.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Imap.ImapFolder"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetHeaders(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetHeadersAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetHeaders(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetHeadersAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetBodyPart(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetBodyPartAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetBodyPart(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetBodyPartAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetStreams(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Gets the streams for the specified messages.</para>
- </remarks>
- <param name="uids">The uids of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetStreamsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Asynchronously gets the streams for the specified messages.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="uids">The uids of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetStreams(System.Collections.Generic.IList{System.Int32},MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Gets the streams for the specified messages.</para>
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Asynchronously gets the streams for the specified messages.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetStreams(System.Int32,System.Int32,MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Gets the streams for the specified messages.</para>
- </remarks>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="callback"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetStreamsAsync(System.Int32,System.Int32,MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Asynchronously gets the streams for the specified messages.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="callback"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.Search(System.String,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SEARCH</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SEARCH</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.SearchAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SEARCH</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SEARCH</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.Sort(System.String,System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SORT</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SORT</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the SORT extension.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.SortAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SORT</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SORT</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the SORT extension.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="T:MailKit.Net.Imap.ImapFetchStreamCallback">
- <summary>
- A callback used when fetching message streams.
- </summary>
- <remarks>
- <para>This callback is meant to be used with the various
- <a href="Overload_MailKit_Net_Imap_ImapFolder_GetStreams.htm">GetStreams</a>
- methods.</para>
- <para>Once this callback returns, the stream argument will be disposed, so
- it is important to consume the stream right away and not add it to a queue
- for later processing.</para>
- </remarks>
- <param name="folder">The IMAP folder that the message belongs to.</param>
- <param name="index">The index of the message in the folder.</param>
- <param name="uid">The UID of the message in the folder.</param>
- <param name="stream">The raw message (or part) stream.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapFetchStreamAsyncCallback">
- <summary>
- An asynchronous callback used when fetching message streams.
- </summary>
- <remarks>
- <para>This callback is meant to be used with the various
- <a href="Overload_MailKit_Net_Imap_ImapFolder_GetStreamsAsync.htm">GetStreamsAsync</a>
- methods.</para>
- <para>Once this callback returns, the stream argument will be disposed, so
- it is important to consume the stream right away and not add it to a queue
- for later processing.</para>
- </remarks>
- <returns>An awaitable task context.</returns>
- <param name="folder">The IMAP folder that the message belongs to.</param>
- <param name="index">The index of the message in the folder.</param>
- <param name="uid">The UID of the message in the folder.</param>
- <param name="stream">The raw message (or part) stream.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapCapabilities">
- <summary>
- Capabilities supported by an IMAP server.
- </summary>
- <remarks>
- Capabilities are read as part of the response to the <c>CAPABILITY</c> command that
- is issued during the connection and authentication phases of the
- <see cref="T:MailKit.Net.Imap.ImapClient"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.None">
- <summary>
- The server does not support any additional extensions.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.IMAP4">
- <summary>
- The server implements the core IMAP4 commands.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.IMAP4rev1">
- <summary>
- The server implements the core IMAP4rev1 commands.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.IMAP4rev2">
- <summary>
- The server implements the core IMAP4rev2 commands.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Status">
- <summary>
- The server supports the <c>STATUS</c> command.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Acl">
- <summary>
- The server supports the ACL extension defined in <a href="https://tools.ietf.org/html/rfc2086">rfc2086</a>
- and <a href="https://tools.ietf.org/html/rfc4314">rfc4314</a>.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Quota">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2087">QUOTA</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.LiteralPlus">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2088">LITERAL+</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Idle">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2177">IDLE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.MailboxReferrals">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2193">MAILBOX-REFERRALS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.LoginReferrals">
- <summary>
- the server supports the <a href="https://tools.ietf.org/html/rfc2221">LOGIN-REFERRALS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Namespace">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2342">NAMESPACE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Id">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2971">ID</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Children">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3348">CHILDREN</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.LoginDisabled">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3501">LOGINDISABLED</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.StartTLS">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3501">STARTTLS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.MultiAppend">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3502">MULTIAPPEND</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Binary">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3516">BINARY</a> content extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Unselect">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3691">UNSELECT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.UidPlus">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc4315">UIDPLUS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Catenate">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc4469">CATENATE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.CondStore">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc4551">CONDSTORE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.ESearch">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc4731">ESEARCH</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.SaslIR">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc4959">SASL-IR</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Compress">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc4978">COMPRESS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Within">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5032">WITHIN</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Enable">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5161">ENABLE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.QuickResync">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.SearchResults">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5182">SEARCHRES</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Sort">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5256">SORT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Thread">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5256">THREAD</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Annotate">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5257">ANNOTATE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.ListExtended">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5258">LIST-EXTENDED</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Convert">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5259">CONVERT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Language">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5255">LANGUAGE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.I18NLevel">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5255">I18NLEVEL</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.ESort">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5267">ESORT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Context">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5267">CONTEXT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Metadata">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5464">METADATA</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.MetadataServer">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5464">METADATA-SERVER</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Notify">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Filters">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5466">FILTERS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.ListStatus">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5819">LIST-STATUS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.SortDisplay">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5957">SORT=DISPLAY</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.CreateSpecialUse">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6154">CREATE-SPECIAL-USE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.SpecialUse">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6154">SPECIAL-USE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.FuzzySearch">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6203">SEARCH=FUZZY</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.MultiSearch">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6237">MULTISEARCH</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Move">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6851">MOVE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.UTF8Accept">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.UTF8Only">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ONLY</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.LiteralMinus">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc7888">LITERAL-</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.AppendLimit">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc7889">APPENDLIMIT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Unauthenticate">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc8437">UNAUTHENTICATE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.StatusSize">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc8438">STATUS=SIZE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.ListMyRights">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc8440">LIST-MYRIGHTS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.ObjectID">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.XList">
- <summary>
- The server supports the <a href="https://developers.google.com/gmail/imap_extensions">XLIST</a> extension (GMail).
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.GMailExt1">
- <summary>
- The server supports the <a href="https://developers.google.com/gmail/imap_extensions">X-GM-EXT1</a> extension (GMail).
- </summary>
- </member>
- <member name="T:MailKit.Net.Imap.ImapContinuationHandler">
- <summary>
- An IMAP continuation handler.
- </summary>
- <remarks>
- All exceptions thrown by the handler are considered fatal and will
- force-disconnect the connection. If a non-fatal error occurs, set
- it on the <see cref="P:MailKit.Net.Imap.ImapCommand.Exception"/> property.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Imap.ImapUntaggedHandler">
- <summary>
- An IMAP untagged response handler.
- </summary>
- <remarks>
- <para>Most IMAP commands return their results in untagged responses.</para>
- </remarks>
- </member>
- <member name="T:MailKit.Net.Imap.ImapCommandStatus">
- <summary>
- IMAP command status.
- </summary>
- </member>
- <member name="T:MailKit.Net.Imap.ImapIdleContext">
- <summary>
- An IMAP IDLE context.
- </summary>
- <remarks>
- <para>An IMAP IDLE command does not work like normal commands. Unlike most commands,
- the IDLE command does not end until the client sends a separate "DONE" command.</para>
- <para>In order to facilitate this, the way this works is that the consumer of MailKit's
- IMAP APIs provides a 'doneToken' which signals to the command-processing loop to
- send the "DONE" command. Since, like every other IMAP command, it is also necessary to
- provide a means of cancelling the IDLE command, it becomes necessary to link the
- 'doneToken' and the 'cancellationToken' together.</para>
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapIdleContext.#ctor(MailKit.Net.Imap.ImapEngine,System.Threading.CancellationToken,System.Threading.CancellationToken)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapIdleContext"/>.
- </remarks>
- <param name="engine">The IMAP engine.</param>
- <param name="doneToken">The done token.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapIdleContext.Engine">
- <summary>
- Get the engine.
- </summary>
- <remarks>
- Gets the engine.
- </remarks>
- <value>The engine.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapIdleContext.CancellationToken">
- <summary>
- Get the cancellation token.
- </summary>
- <remarks>
- Get the cancellation token.
- </remarks>
- <value>The cancellation token.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapIdleContext.DoneToken">
- <summary>
- Get the done token.
- </summary>
- <remarks>
- Gets the done token.
- </remarks>
- <value>The done token.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapIdleContext.ContinuationHandler(MailKit.Net.Imap.ImapEngine,MailKit.Net.Imap.ImapCommand,System.String,System.Boolean)">
- <summary>
- Callback method to be used as the ImapCommand's ContinuationHandler.
- </summary>
- <remarks>
- Callback method to be used as the ImapCommand's ContinuationHandler.
- </remarks>
- <param name="engine">The ImapEngine.</param>
- <param name="ic">The ImapCommand.</param>
- <param name="text">The text.</param>
- <param name="doAsync"><c>true</c> if the command is being run asynchronously; otherwise, <c>false</c>.</param>
- <returns></returns>
- </member>
- <member name="M:MailKit.Net.Imap.ImapIdleContext.Dispose">
- <summary>
- Releases all resource used by the <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> object.
- </summary>
- <remarks>Call <see cref="M:MailKit.Net.Imap.ImapIdleContext.Dispose"/> when you are finished using the <see cref="T:MailKit.Net.Imap.ImapIdleContext"/>. The
- <see cref="M:MailKit.Net.Imap.ImapIdleContext.Dispose"/> method leaves the <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> in an unusable state. After
- calling <see cref="M:MailKit.Net.Imap.ImapIdleContext.Dispose"/>, you must release all references to the
- <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> so the garbage collector can reclaim the memory that the
- <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> was occupying.</remarks>
- </member>
- <member name="T:MailKit.Net.Imap.ImapLiteral">
- <summary>
- An IMAP literal object.
- </summary>
- <remarks>
- The literal can be a string, byte[], Stream, or a MimeMessage.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapLiteral.#ctor(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Action{System.Int32})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapLiteral"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapLiteral"/>.
- </remarks>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="action">The progress update action.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapLiteral.#ctor(MimeKit.FormatOptions,System.Byte[])">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapLiteral"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapLiteral"/>.
- </remarks>
- <param name="options">The formatting options.</param>
- <param name="literal">The literal.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapLiteral.Length">
- <summary>
- Get the length of the literal, in bytes.
- </summary>
- <remarks>
- Gets the length of the literal, in bytes.
- </remarks>
- <value>The length.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapLiteral.WriteToAsync(MailKit.Net.Imap.ImapStream,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Write the literal to the specified stream.
- </summary>
- <remarks>
- Writes the literal to the specified stream.
- </remarks>
- <param name="stream">The stream.</param>
- <param name="doAsync">Whether the literal should be written asynchronously or not.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapCommandPart">
- <summary>
- A partial IMAP command.
- </summary>
- <remarks>
- IMAP commands that contain literal strings are broken up into multiple parts
- in case the IMAP server does not support the LITERAL+ extension. These parts
- are then sent individually as we receive "+" responses from the server.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Imap.ImapCommand">
- <summary>
- An IMAP command.
- </summary>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommand.#ctor(MailKit.Net.Imap.ImapEngine,System.Threading.CancellationToken,MailKit.Net.Imap.ImapFolder,MimeKit.FormatOptions,System.String,System.Object[])">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommand"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapCommand"/>.
- </remarks>
- <param name="engine">The IMAP engine that will be sending the command.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="folder">The IMAP folder that the command operates on.</param>
- <param name="options">The formatting options.</param>
- <param name="format">The command format.</param>
- <param name="args">The command arguments.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommand.#ctor(MailKit.Net.Imap.ImapEngine,System.Threading.CancellationToken,MailKit.Net.Imap.ImapFolder,System.String,System.Object[])">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommand"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapCommand"/>.
- </remarks>
- <param name="engine">The IMAP engine that will be sending the command.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="folder">The IMAP folder that the command operates on.</param>
- <param name="format">The command format.</param>
- <param name="args">The command arguments.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommand.RegisterUntaggedHandler(System.String,MailKit.Net.Imap.ImapUntaggedHandler)">
- <summary>
- Registers the untagged handler for the specified atom token.
- </summary>
- <param name="atom">The atom token.</param>
- <param name="handler">The handler.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="atom"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="handler"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Untagged handlers must be registered before the command has been queued.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommand.StepAsync(System.Boolean)">
- <summary>
- Sends the next part of the command to the server.
- </summary>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Imap.ImapCommandException">
- <summary>
- An exception that is thrown when an IMAP command returns NO or BAD.
- </summary>
- <remarks>
- The exception that is thrown when an IMAP command fails. Unlike a <see cref="T:MailKit.Net.Imap.ImapProtocolException"/>,
- a <see cref="T:MailKit.Net.Imap.ImapCommandException"/> does not require the <see cref="T:MailKit.Net.Imap.ImapClient"/> to be reconnected.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommandException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/> from the serialized data.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommandException.Create(System.String,MailKit.Net.Imap.ImapCommand)">
- <summary>
- Create a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/> based on the specified command name and <see cref="T:MailKit.Net.Imap.ImapCommand"/> state.
- </summary>
- <remarks>
- Create a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/> based on the specified command name and <see cref="T:MailKit.Net.Imap.ImapCommand"/> state.
- </remarks>
- <returns>A new command exception.</returns>
- <param name="command">The command name.</param>
- <param name="ic">The command state.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommandException.#ctor(MailKit.Net.Imap.ImapCommandResponse,System.String,System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/>.
- </remarks>
- <param name="response">The IMAP command response.</param>
- <param name="message">The error message.</param>
- <param name="responseText">The human-readable response text.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommandException.#ctor(MailKit.Net.Imap.ImapCommandResponse,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/>.
- </remarks>
- <param name="response">The IMAP command response.</param>
- <param name="responseText">The human-readable response text.</param>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommandException.#ctor(MailKit.Net.Imap.ImapCommandResponse,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/>.
- </remarks>
- <param name="response">The IMAP command response.</param>
- <param name="responseText">The human-readable response text.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapCommandException.Response">
- <summary>
- Gets the IMAP command response.
- </summary>
- <remarks>
- Gets the IMAP command response.
- </remarks>
- <value>The IMAP command response.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapCommandException.ResponseText">
- <summary>
- Gets the human-readable IMAP command response text.
- </summary>
- <remarks>
- Gets the human-readable IMAP command response text.
- </remarks>
- <value>The response text.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommandException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
- with information about the exception.
- </summary>
- <remarks>
- Serializes the state of the <see cref="T:MailKit.FolderNotFoundException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.Net.Imap.ImapCommandResponse">
- <summary>
- An enumeration of possible IMAP command responses.
- </summary>
- <remarks>
- An enumeration of possible IMAP command responses.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCommandResponse.None">
- <summary>
- No IMAP command response yet.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCommandResponse.Ok">
- <summary>
- The command resulted in an "OK" response.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCommandResponse.No">
- <summary>
- The command resulted in a "NO" response.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCommandResponse.Bad">
- <summary>
- The command resulted in a "BAD" response.
- </summary>
- </member>
- <member name="T:MailKit.Net.Imap.ImapEngineState">
- <summary>
- The state of the <see cref="T:MailKit.Net.Imap.ImapEngine"/>.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEngineState.Disconnected">
- <summary>
- The ImapEngine is in the disconnected state.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEngineState.Connecting">
- <summary>
- The ImapEngine is in the process of connecting.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEngineState.Connected">
- <summary>
- The ImapEngine is connected but not yet authenticated.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEngineState.Authenticated">
- <summary>
- The ImapEngine is in the authenticated state.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEngineState.Selected">
- <summary>
- The ImapEngine is in the selected state.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEngineState.Idle">
- <summary>
- The ImapEngine is in the IDLE state.
- </summary>
- </member>
- <member name="T:MailKit.Net.Imap.ImapEngine">
- <summary>
- An IMAP command engine.
- </summary>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.AuthenticationMechanisms">
- <summary>
- Get the authentication mechanisms supported by the IMAP server.
- </summary>
- <remarks>
- The authentication mechanisms are queried durring the
- <see cref="M:MailKit.Net.Imap.ImapEngine.ConnectAsync(MailKit.Net.Imap.ImapStream,System.Boolean,System.Threading.CancellationToken)"/> method.
- </remarks>
- <value>The authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.CompressionAlgorithms">
- <summary>
- Get the compression algorithms supported by the IMAP server.
- </summary>
- <remarks>
- The compression algorithms are populated by the
- <see cref="M:MailKit.Net.Imap.ImapEngine.QueryCapabilitiesAsync(System.Boolean,System.Threading.CancellationToken)"/> method.
- </remarks>
- <value>The compression algorithms.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.ThreadingAlgorithms">
- <summary>
- Get the threading algorithms supported by the IMAP server.
- </summary>
- <remarks>
- The threading algorithms are populated by the
- <see cref="M:MailKit.Net.Imap.ImapEngine.QueryCapabilitiesAsync(System.Boolean,System.Threading.CancellationToken)"/> method.
- </remarks>
- <value>The threading algorithms.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.AppendLimit">
- <summary>
- Gets the append limit supported by the IMAP server.
- </summary>
- <remarks>
- Gets the append limit supported by the IMAP server.
- </remarks>
- <value>The append limit.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.I18NLevel">
- <summary>
- Gets the I18NLEVEL supported by the IMAP server.
- </summary>
- <remarks>
- Gets the I18NLEVEL supported by the IMAP server.
- </remarks>
- <value>The internationalization level.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Capabilities">
- <summary>
- Get the capabilities supported by the IMAP server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection
- has been made via the <see cref="M:MailKit.Net.Imap.ImapEngine.ConnectAsync(MailKit.Net.Imap.ImapStream,System.Boolean,System.Threading.CancellationToken)"/> method.
- </remarks>
- <value>The capabilities.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.IsBusy">
- <summary>
- Indicates whether or not the engine is busy processing commands.
- </summary>
- <remarks>
- Indicates whether or not the engine is busy processing commands.
- </remarks>
- <value><c>true</c> if th e engine is busy processing commands; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.CapabilitiesVersion">
- <summary>
- Get the capabilities version.
- </summary>
- <remarks>
- Every time the engine receives an untagged CAPABILITIES
- response from the server, it increments this value.
- </remarks>
- <value>The capabilities version.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.ProtocolVersion">
- <summary>
- Get the IMAP protocol version.
- </summary>
- <remarks>
- Gets the IMAP protocol version.
- </remarks>
- <value>The IMAP protocol version.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Rights">
- <summary>
- Get the rights specified in the capabilities.
- </summary>
- <remarks>
- Gets the rights specified in the capabilities.
- </remarks>
- <value>The rights.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.SupportedCharsets">
- <summary>
- Get the supported charsets.
- </summary>
- <remarks>
- Gets the supported charsets.
- </remarks>
- <value>The supported charsets.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.SupportedContexts">
- <summary>
- Get the supported contexts.
- </summary>
- <remarks>
- Gets the supported contexts.
- </remarks>
- <value>The supported contexts.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.QResyncEnabled">
- <summary>
- Get whether or not the QRESYNC feature has been enabled.
- </summary>
- <remarks>
- Gets whether or not the QRESYNC feature has been enabled.
- </remarks>
- <value><c>true</c> if the QRESYNC feature has been enabled; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.UTF8Enabled">
- <summary>
- Get whether or not the UTF8=ACCEPT feature has been enabled.
- </summary>
- <remarks>
- Gets whether or not the UTF8=ACCEPT feature has been enabled.
- </remarks>
- <value><c>true</c> if the UTF8=ACCEPT feature has been enabled; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Uri">
- <summary>
- Get the URI of the IMAP server.
- </summary>
- <remarks>
- Gets the URI of the IMAP server.
- </remarks>
- <value>The URI of the IMAP server.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Stream">
- <summary>
- Get the underlying IMAP stream.
- </summary>
- <remarks>
- Gets the underlying IMAP stream.
- </remarks>
- <value>The IMAP stream.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.State">
- <summary>
- Get or sets the state of the engine.
- </summary>
- <remarks>
- Gets or sets the state of the engine.
- </remarks>
- <value>The engine state.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.IsConnected">
- <summary>
- Get whether or not the engine is currently connected to a IMAP server.
- </summary>
- <remarks>
- Gets whether or not the engine is currently connected to a IMAP server.
- </remarks>
- <value><c>true</c> if the engine is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.PersonalNamespaces">
- <summary>
- Gets the personal folder namespaces.
- </summary>
- <remarks>
- Gets the personal folder namespaces.
- </remarks>
- <value>The personal folder namespaces.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.SharedNamespaces">
- <summary>
- Gets the shared folder namespaces.
- </summary>
- <remarks>
- Gets the shared folder namespaces.
- </remarks>
- <value>The shared folder namespaces.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.OtherNamespaces">
- <summary>
- Gets the other folder namespaces.
- </summary>
- <remarks>
- Gets the other folder namespaces.
- </remarks>
- <value>The other folder namespaces.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Selected">
- <summary>
- Gets the selected folder.
- </summary>
- <remarks>
- Gets the selected folder.
- </remarks>
- <value>The selected folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.IsDisposed">
- <summary>
- Gets a value indicating whether the engine is disposed.
- </summary>
- <remarks>
- Gets a value indicating whether the engine is disposed.
- </remarks>
- <value><c>true</c> if the engine is disposed; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.NotifySelectedNewExpunge">
- <summary>
- Gets whether the current NOTIFY status prevents using indexes and * for referencing messages.
- </summary>
- <remarks>
- Gets whether the current NOTIFY status prevents using indexes and * for referencing messages. This is the case when the client has asked for MessageNew or MessageExpunge events on the SELECTED mailbox.
- </remarks>
- <value><c>true</c> if the use of indexes and * is prevented; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Inbox">
- <summary>
- Gets the Inbox folder.
- </summary>
- <value>The Inbox folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.All">
- <summary>
- Gets the special folder containing an aggregate of all messages.
- </summary>
- <value>The folder containing all messages.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Archive">
- <summary>
- Gets the special archive folder.
- </summary>
- <value>The archive folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Drafts">
- <summary>
- Gets the special folder containing drafts.
- </summary>
- <value>The drafts folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Flagged">
- <summary>
- Gets the special folder containing flagged messages.
- </summary>
- <value>The flagged folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Junk">
- <summary>
- Gets the special folder containing junk messages.
- </summary>
- <value>The junk folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Sent">
- <summary>
- Gets the special folder containing sent messages.
- </summary>
- <value>The sent.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Trash">
- <summary>
- Gets the folder containing deleted messages.
- </summary>
- <value>The trash folder.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.SetStream(MailKit.Net.Imap.ImapStream)">
- <summary>
- Sets the stream - this is only here to be used by the unit tests.
- </summary>
- <param name="stream">The IMAP stream.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.ConnectAsync(MailKit.Net.Imap.ImapStream,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Takes posession of the <see cref="T:MailKit.Net.Imap.ImapStream"/> and reads the greeting.
- </summary>
- <param name="stream">The IMAP stream.</param>
- <param name="doAsync">Whether or not asyncrhonois IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.Disconnect">
- <summary>
- Disconnects the <see cref="T:MailKit.Net.Imap.ImapEngine"/>.
- </summary>
- <remarks>
- Disconnects the <see cref="T:MailKit.Net.Imap.ImapEngine"/>.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.ReadToken(System.Threading.CancellationToken)">
- <summary>
- Reads the next token.
- </summary>
- <returns>The token.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.InvalidOperationException">
- The engine is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.ParseResponseCodeAsync(System.Boolean,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses the response code.
- </summary>
- <returns>The response code.</returns>
- <param name="isTagged">Whether or not the resp-code is tagged vs untagged.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.ProcessUntaggedResponseAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Processes an untagged response.
- </summary>
- <returns>The untagged response.</returns>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.IterateAsync(System.Boolean)">
- <summary>
- Iterate the command pipeline.
- </summary>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.RunAsync(MailKit.Net.Imap.ImapCommand,System.Boolean)">
- <summary>
- Wait for the specified command to finish.
- </summary>
- <param name="ic">The IMAP command.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="ic"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.QueueCommand(System.Threading.CancellationToken,MailKit.Net.Imap.ImapFolder,MimeKit.FormatOptions,System.String,System.Object[])">
- <summary>
- Queues the command.
- </summary>
- <returns>The command.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="folder">The folder that the command operates on.</param>
- <param name="options">The formatting options.</param>
- <param name="format">The command format.</param>
- <param name="args">The command arguments.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.QueueCommand(System.Threading.CancellationToken,MailKit.Net.Imap.ImapFolder,System.String,System.Object[])">
- <summary>
- Queues the command.
- </summary>
- <returns>The command.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="folder">The folder that the command operates on.</param>
- <param name="format">The command format.</param>
- <param name="args">The command arguments.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.QueueCommand(MailKit.Net.Imap.ImapCommand)">
- <summary>
- Queues the command.
- </summary>
- <param name="ic">The IMAP command.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.QueryCapabilitiesAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Queries the capabilities.
- </summary>
- <returns>The command result.</returns>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.CacheFolder(MailKit.Net.Imap.ImapFolder)">
- <summary>
- Cache the specified folder.
- </summary>
- <param name="folder">The folder.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.GetCachedFolder(System.String,MailKit.Net.Imap.ImapFolder@)">
- <summary>
- Gets the cached folder.
- </summary>
- <returns><c>true</c> if the folder was retreived from the cache; otherwise, <c>false</c>.</returns>
- <param name="encodedName">The encoded folder name.</param>
- <param name="folder">The cached folder.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.LookupParentFoldersAsync(System.Collections.Generic.IEnumerable{MailKit.Net.Imap.ImapFolder},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Looks up and sets the <see cref="P:MailKit.MailFolder.ParentFolder"/> property of each of the folders.
- </summary>
- <param name="folders">The IMAP folders.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.QueryNamespacesAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Queries the namespaces.
- </summary>
- <returns>The command result.</returns>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.AssignSpecialFolder(MailKit.Net.Imap.ImapFolder)">
- <summary>
- Assigns a folder as a special folder.
- </summary>
- <param name="folder">The special folder.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.AssignSpecialFolders(System.Collections.Generic.IList{MailKit.Net.Imap.ImapFolder})">
- <summary>
- Assigns the special folders.
- </summary>
- <param name="list">The list of folders.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.QuerySpecialFoldersAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Queries the special folders.
- </summary>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.GetQuotaRootFolderAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Gets the folder representing the specified quota root.
- </summary>
- <returns>The folder.</returns>
- <param name="quotaRoot">The name of the quota root.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.GetFolderAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Gets the folder for the specified path.
- </summary>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.GetFoldersAsync(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The list of folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.DecodeMailboxName(System.String)">
- <summary>
- Decodes the name of the mailbox.
- </summary>
- <returns>The mailbox name.</returns>
- <param name="encodedName">The encoded name.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.EncodeMailboxName(System.String)">
- <summary>
- Encodes the name of the mailbox.
- </summary>
- <returns>The mailbox name.</returns>
- <param name="mailboxName">The encoded mailbox name.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.IsValidMailboxName(System.String,System.Char)">
- <summary>
- Determines whether the mailbox name is valid or not.
- </summary>
- <returns><c>true</c> if the mailbox name is valid; otherwise, <c>false</c>.</returns>
- <param name="mailboxName">The mailbox name.</param>
- <param name="delim">The path delimeter.</param>
- </member>
- <member name="E:MailKit.Net.Imap.ImapEngine.Alert">
- <summary>
- Occurs when the engine receives an alert message from the server.
- </summary>
- </member>
- <member name="E:MailKit.Net.Imap.ImapEngine.FolderCreated">
- <summary>
- Occurs when the engine receives a notification that a folder has been created.
- </summary>
- </member>
- <member name="E:MailKit.Net.Imap.ImapEngine.MetadataChanged">
- <summary>
- Occurs when the engine receives a notification that metadata has changed.
- </summary>
- </member>
- <member name="E:MailKit.Net.Imap.ImapEngine.NotificationOverflow">
- <summary>
- Occurs when the engine receives a notification overflow message from the server.
- </summary>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.Dispose">
- <summary>
- Releases all resource used by the <see cref="T:MailKit.Net.Imap.ImapEngine"/> object.
- </summary>
- <remarks>Call <see cref="M:MailKit.Net.Imap.ImapEngine.Dispose"/> when you are finished using the <see cref="T:MailKit.Net.Imap.ImapEngine"/>. The
- <see cref="M:MailKit.Net.Imap.ImapEngine.Dispose"/> method leaves the <see cref="T:MailKit.Net.Imap.ImapEngine"/> in an unusable state. After
- calling <see cref="M:MailKit.Net.Imap.ImapEngine.Dispose"/>, you must release all references to the <see cref="T:MailKit.Net.Imap.ImapEngine"/> so
- the garbage collector can reclaim the memory that the <see cref="T:MailKit.Net.Imap.ImapEngine"/> was occupying.</remarks>
- </member>
- <member name="T:MailKit.Net.Imap.ImapEventGroup">
- <summary>
- An IMAP event group used with the NOTIFY command.
- </summary>
- <remarks>
- An IMAP event group used with the NOTIFY command.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEventGroup.#ctor(MailKit.Net.Imap.ImapMailboxFilter,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEvent})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> class.
- </remarks>
- <param name="mailboxFilter">The mailbox filter.</param>
- <param name="events">The list of IMAP events.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="mailboxFilter"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="events"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEventGroup.MailboxFilter">
- <summary>
- Get the mailbox filter.
- </summary>
- <remarks>
- Gets the mailbox filter.
- </remarks>
- <value>The mailbox filter.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEventGroup.Events">
- <summary>
- Get the list of IMAP events.
- </summary>
- <remarks>
- Gets the list of IMAP events.
- </remarks>
- <value>The events.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEventGroup.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object},System.Boolean@)">
- <summary>
- Format the IMAP NOTIFY command for this particular IMAP event group.
- </summary>
- <remarks>
- Formats the IMAP NOTIFY command for this particular IMAP event group.
- </remarks>
- <param name="engine">The IMAP engine.</param>
- <param name="command">The IMAP command builder.</param>
- <param name="args">The IMAP command argument builder.</param>
- <param name="notifySelectedNewExpunge">Gets set to <c>true</c> if the NOTIFY command requests the MessageNew or
- MessageExpunged events for a SELECTED or SELECTED-DELAYED mailbox filter; otherwise it is left unchanged.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapMailboxFilter">
- <summary>
- An IMAP mailbox filter for use with the NOTIFY command.
- </summary>
- <remarks>
- An IMAP mailbox filter for use with the NOTIFY command.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapMailboxFilter.Selected">
- <summary>
- An IMAP mailbox filter specifying that the client wants immediate notifications for
- the currently selected folder.
- </summary>
- <remarks>
- The <c>SELECTED</c> mailbox specifier requires the server to send immediate
- notifications for the currently selected mailbox about all specified
- message events.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapMailboxFilter.SelectedDelayed">
- <summary>
- An IMAP mailbox filter specifying the currently selected folder but delays notifications
- until a command has been issued.
- </summary>
- <remarks>
- The <c>SELECTED-DELAYED</c> mailbox specifier requires the server to delay a
- <see cref="F:MailKit.Net.Imap.ImapEvent.MessageExpunge"/> event until the client issues a command that allows
- returning information about expunged messages (see
- <a href="https://tools.ietf.org/html/rfc3501#section-7.4.1">Section 7.4.1 of RFC3501]</a>
- for more details), for example, till a <c>NOOP</c> or an <c>IDLE</c> command has been issued.
- When <c>SELECTED-DELAYED</c> is specified, the server MAY also delay returning other message
- events until the client issues one of the commands specified above, or it MAY return them
- immediately.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapMailboxFilter.Inboxes">
- <summary>
- An IMAP mailbox filter specifying the currently selected folder.
- </summary>
- <remarks>
- <para>The <c>INBOXES</c> mailbox specifier refers to all selectable mailboxes in the user's
- personal namespace(s) to which messages may be delivered by a Message Delivery Agent (MDA).
- </para>
- <para>If the IMAP server cannot easily compute this set, it MUST treat <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Inboxes"/>
- as equivalent to <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Personal"/>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapMailboxFilter.Personal">
- <summary>
- An IMAP mailbox filter specifying all selectable folders within the user's personal namespace.
- </summary>
- <remarks>
- The <c>PERSONAL</c> mailbox specifier refers to all selectable folders within the user's personal namespace.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapMailboxFilter.Subscribed">
- <summary>
- An IMAP mailbox filter that refers to all subscribed folders.
- </summary>
- <remarks>
- <para>The <c>SUBSCRIBED</c> mailbox specifier refers to all folders subscribed to by the user.</para>
- <para>If the subscription list changes, the server MUST reevaluate the list.</para>
- </remarks>
- </member>
- <member name="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes">
- <summary>
- An IMAP mailbox filter that specifies a list of folders to receive notifications about.
- </summary>
- <remarks>
- An IMAP mailbox filter that specifies a list of folders to receive notifications about.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes.#ctor(System.Collections.Generic.IList{MailKit.IMailFolder})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
- </remarks>
- <param name="folders">The list of folders to watch for events.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folders"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The list of <paramref name="folders"/> is empty.</para>
- <para>-or-</para>
- <para>The list of <paramref name="folders"/> contains folders that are not of
- type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes.#ctor(MailKit.IMailFolder[])">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
- </remarks>
- <param name="folders">The list of folders to watch for events.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folders"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The list of <paramref name="folders"/> is empty.</para>
- <para>-or-</para>
- <para>The list of <paramref name="folders"/> contains folders that are not of
- type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes.#ctor(System.String,System.Collections.Generic.IList{MailKit.IMailFolder})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
- </remarks>
- <param name="name">The name of the mailbox filter.</param>
- <param name="folders">The list of folders to watch for events.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folders"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The list of <paramref name="folders"/> is empty.</para>
- <para>-or-</para>
- <para>The list of <paramref name="folders"/> contains folders that are not of
- type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object})">
- <summary>
- Format the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </summary>
- <remarks>
- Formats the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </remarks>
- <param name="engine">The IMAP engine.</param>
- <param name="command">The IMAP command builder.</param>
- <param name="args">The IMAP command argument builder.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree">
- <summary>
- An IMAP mailbox filter that specifies a list of folder subtrees to get notifications about.
- </summary>
- <remarks>
- <para>The client will receive notifications for each specified folder plus all selectable
- folders that are subordinate to any of the specified folders.</para>
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Subtree.#ctor(System.Collections.Generic.IList{MailKit.IMailFolder})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree"/> class.
- </remarks>
- <param name="folders">The list of folders to watch for events.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folders"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The list of <paramref name="folders"/> is empty.</para>
- <para>-or-</para>
- <para>The list of <paramref name="folders"/> contains folders that are not of
- type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Subtree.#ctor(MailKit.IMailFolder[])">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree"/> class.
- </remarks>
- <param name="folders">The list of folders to watch for events.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folders"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The list of <paramref name="folders"/> is empty.</para>
- <para>-or-</para>
- <para>The list of <paramref name="folders"/> contains folders that are not of
- type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter"/> class.
- </remarks>
- <param name="name">The name of the mailbox filter.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapMailboxFilter.Name">
- <summary>
- Get the name of the mailbox filter.
- </summary>
- <remarks>
- Gets the name of the mailbox filter.
- </remarks>
- <value>The name.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object})">
- <summary>
- Format the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </summary>
- <remarks>
- Formats the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </remarks>
- <param name="engine">The IMAP engine.</param>
- <param name="command">The IMAP command builder.</param>
- <param name="args">The IMAP command argument builder.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapEvent">
- <summary>
- An IMAP notification event.
- </summary>
- <remarks>
- An IMAP notification event.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.MessageExpunge">
- <summary>
- An IMAP event notification for expunged messages.
- </summary>
- <remarks>
- <para>If the expunged message or messages are in the selected mailbox, the server notifies the client
- using <see cref="E:MailKit.IMailFolder.MessageExpunged"/> (or <see cref="E:MailKit.IMailFolder.MessagesVanished"/> if
- the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a> extension has been enabled via
- <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/> or
- <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResyncAsync(System.Threading.CancellationToken)"/>).</para>
- <para>If the expunged message or messages are in another mailbox, the <see cref="P:MailKit.IMailFolder.UidNext"/>
- and <see cref="P:MailKit.IMailFolder.Count"/> properties will be updated and the appropriate
- <see cref="E:MailKit.IMailFolder.UidNextChanged"/> and <see cref="E:MailKit.IMailFolder.CountChanged"/> events will be
- emitted for the relevant folder. If the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a>
- extension is enabled, the <see cref="P:MailKit.IMailFolder.HighestModSeq"/> property will also be updated and
- the <see cref="E:MailKit.IMailFolder.HighestModSeqChanged"/> event will be emitted.</para>
- <note type="note">if a client requests <see cref="F:MailKit.Net.Imap.ImapEvent.MessageExpunge"/> with the <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Selected"/>
- mailbox specifier, the meaning of a message index can change at any time, so the client cannot use
- message indexes in commands anymore. The client MUST use API variants that take <see cref="T:MailKit.UniqueId"/> or
- a <see cref="T:System.Collections.Generic.IList`1"/>. The meaning of <c>*</c>* can also change when messages are added or expunged.
- A client wishing to keep using message indexes can either use the <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.SelectedDelayed"/>
- mailbox specifier or can avoid using the <see cref="F:MailKit.Net.Imap.ImapEvent.MessageExpunge"/> event entirely.</note>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.FlagChange">
- <summary>
- An IMAP event notification for message flag changes.
- </summary>
- <remarks>
- <para>If the <see cref="F:MailKit.Net.Imap.ImapEvent.FlagChange"/> notification arrives for a message located in the currently selected
- folder, then that folder will emit a <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> event as well as a
- <see cref="E:MailKit.IMailFolder.MessageSummaryFetched"/> event with an appropriately populated
- <see cref="T:MailKit.IMessageSummary"/>.</para>
- <para>On the other hand, if the <see cref="F:MailKit.Net.Imap.ImapEvent.FlagChange"/> notification arrives for a message that is not
- located in the currently selected folder, then the events that are emitted will depend on the
- <see cref="T:MailKit.Net.Imap.ImapCapabilities"/> of the IMAP server.</para>
- <para>If the server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.CondStore"/> capability (or the
- <see cref="F:MailKit.Net.Imap.ImapCapabilities.QuickResync"/> capability and the client has enabled it via
- <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>), then the
- <see cref="E:MailKit.IMailFolder.HighestModSeqChanged"/> event will be emitted as well as the
- <see cref="E:MailKit.IMailFolder.UidValidityChanged"/> event (if the latter has changed). If the number of
- seen messages has changed, then the <see cref="E:MailKit.IMailFolder.UnreadChanged"/> event may also be emitted.</para>
- <para>If the server does not support either the <see cref="F:MailKit.Net.Imap.ImapCapabilities.CondStore"/> capability nor
- the <see cref="F:MailKit.Net.Imap.ImapCapabilities.QuickResync"/> capability and the client has not enabled the later capability
- via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>, then the server may choose
- only to notify the client of <see cref="P:MailKit.IMailFolder.UidValidity"/> changes by emitting the
- <see cref="E:MailKit.IMailFolder.UidValidityChanged"/> event.</para>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.AnnotationChange">
- <summary>
- An IMAP event notification for message annotation changes.
- </summary>
- <remarks>
- <para>If the <see cref="F:MailKit.Net.Imap.ImapEvent.AnnotationChange"/> notification arrives for a message located in the currently selected
- folder, then that folder will emit a <see cref="E:MailKit.IMailFolder.AnnotationsChanged"/> event as well as a
- <see cref="E:MailKit.IMailFolder.MessageSummaryFetched"/> event with an appropriately populated
- <see cref="T:MailKit.IMessageSummary"/>.</para>
- <para>On the other hand, if the <see cref="F:MailKit.Net.Imap.ImapEvent.AnnotationChange"/> notification arrives for a message that is not
- located in the currently selected folder, then the events that are emitted will depend on the
- <see cref="T:MailKit.Net.Imap.ImapCapabilities"/> of the IMAP server.</para>
- <para>If the server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.CondStore"/> capability (or the
- <see cref="F:MailKit.Net.Imap.ImapCapabilities.QuickResync"/> capability and the client has enabled it via
- <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>), then the
- <see cref="E:MailKit.IMailFolder.HighestModSeqChanged"/> event will be emitted as well as the
- <see cref="E:MailKit.IMailFolder.UidValidityChanged"/> event (if the latter has changed). If the number of
- seen messages has changed, then the <see cref="E:MailKit.IMailFolder.UnreadChanged"/> event may also be emitted.</para>
- <para>If the server does not support either the <see cref="F:MailKit.Net.Imap.ImapCapabilities.CondStore"/> capability nor
- the <see cref="F:MailKit.Net.Imap.ImapCapabilities.QuickResync"/> capability and the client has not enabled the later capability
- via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>, then the server may choose
- only to notify the client of <see cref="P:MailKit.IMailFolder.UidValidity"/> changes by emitting the
- <see cref="E:MailKit.IMailFolder.UidValidityChanged"/> event.</para>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.MailboxName">
- <summary>
- AN IMAP event notification for folders that have been created, deleted, or renamed.
- </summary>
- <remarks>
- <para>These notifications are sent if an affected mailbox name was created, deleted, or renamed.</para>
- <para>As these notifications are received by the client, the apropriate will be emitted:
- <see cref="E:MailKit.MailStore.FolderCreated"/>, <see cref="E:MailKit.IMailFolder.Deleted"/>, or
- <see cref="E:MailKit.IMailFolder.Renamed"/>, respectively.</para>
- <note type="info">If the server supports <see cref="F:MailKit.Net.Imap.ImapCapabilities.Acl"/>, granting or revocation of the
- <see cref="F:MailKit.AccessRight.LookupFolder"/> right to the current user on the affected folder will also be
- considered folder creation or deletion, respectively. If a folder is created or deleted, the folder itself
- and its direct parent (whether it is an existing folder or not) are considered to be affected.</note>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.SubscriptionChange">
- <summary>
- An IMAP event notification for folders who have had their subscription status changed.
- </summary>
- <remarks>
- <para>This event requests that the server notifies the client of any subscription changes,
- causing the <see cref="E:MailKit.IMailFolder.Subscribed"/> or <see cref="E:MailKit.IMailFolder.Unsubscribed"/>
- events to be emitted accordingly on the affected <see cref="T:MailKit.IMailFolder"/>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.MailboxMetadataChange">
- <summary>
- An IMAP event notification for changes to folder metadata.
- </summary>
- <remarks>
- <para>Support for this event type is OPTIONAL unless <see cref="F:MailKit.Net.Imap.ImapCapabilities.Metadata"/> is supported
- by the server, in which case support for this event type is REQUIRED.</para>
- <para>If the server does support this event, then the <see cref="E:MailKit.IMailFolder.MetadataChanged"/> event
- will be emitted whenever metadata changes for any folder included in the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter"/>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.ServerMetadataChange">
- <summary>
- An IMAP event notification for changes to server metadata.
- </summary>
- <remarks>
- <para>Support for this event type is OPTIONAL unless <see cref="F:MailKit.Net.Imap.ImapCapabilities.Metadata"/> is supported
- by the server, in which case support for this event type is REQUIRED.</para>
- <para>If the server does support this event, then the <see cref="E:MailKit.IMailStore.MetadataChanged"/> event
- will be emitted whenever metadata changes.</para>
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEvent.#ctor(System.String,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent"/> class.
- </remarks>
- <param name="name">The name of the IMAP event.</param>
- <param name="isMessageEvent"><c>true</c> if the event is a message event; otherwise, <c>false</c>.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEvent.IsMessageEvent">
- <summary>
- Get whether or not this <see cref="T:MailKit.Net.Imap.ImapEvent"/> is a message event.
- </summary>
- <remarks>
- Gets whether or not this <see cref="T:MailKit.Net.Imap.ImapEvent"/> is a message event.
- </remarks>
- <value><c>true</c> if is message event; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEvent.Name">
- <summary>
- Get the name of the IMAP event.
- </summary>
- <remarks>
- Gets the name of the IMAP event.
- </remarks>
- <value>The name of the IMAP event.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEvent.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object},System.Boolean)">
- <summary>
- Format the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </summary>
- <remarks>
- Formats the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </remarks>
- <param name="engine">The IMAP engine.</param>
- <param name="command">The IMAP command builder.</param>
- <param name="args">The IMAP command argument builder.</param>
- <param name="isSelectedFilter"><c>true</c> if the event is being registered for a
- <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Selected"/> or <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.SelectedDelayed"/>
- mailbox filter.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapEvent.MessageNew">
- <summary>
- An IMAP event notification for new or appended messages.
- </summary>
- <remarks>
- <para>An IMAP event notification for new or appended messages.</para>
- <para>If the new or appended message is in the selected folder, the folder will emit the
- <see cref="E:MailKit.IMailFolder.CountChanged"/> event, followed by a
- <see cref="E:MailKit.IMailFolder.MessageSummaryFetched"/> event containing the information requested by the client.</para>
- <note type="note">These events will not be emitted for any message created by the client on this particular folder
- as a result of, for example, a call to
- <see cref="M:MailKit.IMailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>
- or <see cref="M:MailKit.IMailFolder.CopyTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)"/>.</note>
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEvent.MessageNew.#ctor(MailKit.MessageSummaryItems)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
- </remarks>
- <param name="items">The message summary items to automatically retrieve for new messages.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEvent.MessageNew.#ctor(MailKit.MessageSummaryItems,System.Collections.Generic.HashSet{MimeKit.HeaderId})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
- </remarks>
- <param name="items">The message summary items to automatically retrieve for new messages.</param>
- <param name="headers">Additional message headers to retrieve for new messages.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEvent.MessageNew.#ctor(MailKit.MessageSummaryItems,System.Collections.Generic.HashSet{System.String})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
- </remarks>
- <param name="items">The message summary items to automatically retrieve for new messages.</param>
- <param name="headers">Additional message headers to retrieve for new messages.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEvent.MessageNew.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object},System.Boolean)">
- <summary>
- Format the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </summary>
- <remarks>
- Formats the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </remarks>
- <param name="engine">The IMAP engine.</param>
- <param name="command">The IMAP command builder.</param>
- <param name="args">The IMAP command argument builder.</param>
- <param name="isSelectedFilter"><c>true</c> if the event is being registered for a
- <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Selected"/> or <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.SelectedDelayed"/>
- mailbox filter.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapFolder">
- <summary>
- An IMAP folder.
- </summary>
- <remarks>
- An IMAP folder.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.#ctor(MailKit.Net.Imap.ImapFolderConstructorArgs)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapFolder"/> class.
- </summary>
- <remarks>
- <para>Creates a new <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
- <para>If you subclass <see cref="T:MailKit.Net.Imap.ImapFolder"/>, you will also need to subclass
- <see cref="T:MailKit.Net.Imap.ImapClient"/> and override the
- <see cref="M:MailKit.Net.Imap.ImapClient.CreateImapFolder(MailKit.Net.Imap.ImapFolderConstructorArgs)"/>
- method in order to return a new instance of your ImapFolder subclass.</para>
- </remarks>
- <param name="args">The constructor arguments.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="args"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolder.Engine">
- <summary>
- Get the IMAP command engine.
- </summary>
- <remarks>
- Gets the IMAP command engine.
- </remarks>
- <value>The engine.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolder.EncodedName">
- <summary>
- Get the encoded name of the folder.
- </summary>
- <remarks>
- Gets the encoded name of the folder.
- </remarks>
- <value>The encoded name.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolder.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the IMAP server.
- </summary>
- <remarks>
- <para>Gets an object that can be used to synchronize access to the IMAP server.</para>
- <para>When using the non-Async methods from multiple threads, it is important to lock the
- <see cref="P:MailKit.Net.Imap.ImapFolder.SyncRoot"/> object for thread safety when using the synchronous methods.</para>
- </remarks>
- <value>The lock object.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.OnParentFolderRenamed">
- <summary>
- Notifies the folder that a parent folder has been renamed.
- </summary>
- <remarks>
- Updates the <see cref="P:MailKit.MailFolder.FullName"/> property.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolder.IsOpen">
- <summary>
- Gets a value indicating whether the folder is currently open.
- </summary>
- <remarks>
- Gets a value indicating whether the folder is currently open.
- </remarks>
- <value><c>true</c> if the folder is currently open; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Open the folder using the requested folder access.
- </summary>
- <remarks>
- <para>This variant of the <see cref="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- method is meant for quick resynchronization of the folder. Before calling this method,
- the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
- <para>You should also make sure to add listeners to the <see cref="E:MailKit.MailFolder.MessagesVanished"/> and
- <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events to get notifications of changes since
- the last time the folder was opened.</para>
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="uidValidity">The last known <see cref="P:MailKit.MailFolder.UidValidity"/> value.</param>
- <param name="highestModSeq">The last known <see cref="P:MailKit.MailFolder.HighestModSeq"/> value.</param>
- <param name="uids">The last known list of unique message identifiers.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The QRESYNC feature has not been enabled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QRESYNC extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.OpenAsync(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously open the folder using the requested folder access.
- </summary>
- <remarks>
- <para>This variant of the <see cref="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- method is meant for quick resynchronization of the folder. Before calling this method,
- the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
- <para>You should also make sure to add listeners to the <see cref="E:MailKit.MailFolder.MessagesVanished"/> and
- <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events to get notifications of changes since
- the last time the folder was opened.</para>
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="uidValidity">The last known <see cref="P:MailKit.MailFolder.UidValidity"/> value.</param>
- <param name="highestModSeq">The last known <see cref="P:MailKit.MailFolder.HighestModSeq"/> value.</param>
- <param name="uids">The last known list of unique message identifiers.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The QRESYNC feature has not been enabled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QRESYNC extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)">
- <summary>
- Open the folder using the requested folder access.
- </summary>
- <remarks>
- Opens the folder using the requested folder access.
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)">
- <summary>
- Asynchronously open the folder using the requested folder access.
- </summary>
- <remarks>
- Opens the folder using the requested folder access.
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Close(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Close the folder, optionally expunging the messages marked for deletion.
- </summary>
- <remarks>
- Closes the folder, optionally expunging the messages marked for deletion.
- </remarks>
- <param name="expunge">If set to <c>true</c>, expunge.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CloseAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously close the folder, optionally expunging the messages marked for deletion.
- </summary>
- <remarks>
- Closes the folder, optionally expunging the messages marked for deletion.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="expunge">If set to <c>true</c>, expunge.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Create(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CreateAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Create(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUses">A list of special uses for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="specialUses"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the CREATE-SPECIAL-USE extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CreateAsync(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUses">A list of special uses for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="specialUses"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the CREATE-SPECIAL-USE extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Rename(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
- <summary>
- Rename the folder to exist with a new name under a new parent folder.
- </summary>
- <remarks>
- Renames the folder to exist with a new name under a new parent folder.
- </remarks>
- <param name="parent">The new parent folder.</param>
- <param name="name">The new name of the folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="parent"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="parent"/> does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is not a legal folder name.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be renamed (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RenameAsync(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously rename the folder to exist with a new name under a new parent folder.
- </summary>
- <remarks>
- Renames the folder to exist with a new name under a new parent folder.
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="parent">The new parent folder.</param>
- <param name="name">The new name of the folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="parent"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="parent"/> does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is not a legal folder name.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be renamed (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Delete(System.Threading.CancellationToken)">
- <summary>
- Delete the folder on the IMAP server.
- </summary>
- <remarks>
- <para>Deletes the folder on the IMAP server.</para>
- <note type="note">This method will not delete any child folders.</note>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be deleted (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.DeleteAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously delete the folder on the IMAP server.
- </summary>
- <remarks>
- <para>Deletes the folder on the IMAP server.</para>
- <note type="note">This method will not delete any child folders.</note>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be deleted (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Subscribe(System.Threading.CancellationToken)">
- <summary>
- Subscribe the folder.
- </summary>
- <remarks>
- Subscribes the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SubscribeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously subscribe the folder.
- </summary>
- <remarks>
- Subscribes the folder.
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Unsubscribe(System.Threading.CancellationToken)">
- <summary>
- Unsubscribe the folder.
- </summary>
- <remarks>
- Unsubscribes the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.UnsubscribeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously unsubscribe the folder.
- </summary>
- <remarks>
- Unsubscribes the folder.
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetSubfolders(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get the subfolders.
- </summary>
- <remarks>
- Gets the subfolders.
- </remarks>
- <returns>The subfolders.</returns>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetSubfoldersAsync(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the subfolders.
- </summary>
- <remarks>
- Gets the subfolders.
- </remarks>
- <returns>The subfolders.</returns>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetSubfolder(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the specified subfolder.
- </summary>
- <remarks>
- Gets the specified subfolder.
- </remarks>
- <returns>The subfolder.</returns>
- <param name="name">The name of the subfolder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is either an empty string or contains the <see cref="P:MailKit.MailFolder.DirectorySeparator"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The requested folder could not be found.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetSubfolderAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the specified subfolder.
- </summary>
- <remarks>
- Gets the specified subfolder.
- </remarks>
- <returns>The subfolder.</returns>
- <param name="name">The name of the subfolder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is either an empty string or contains the <see cref="P:MailKit.MailFolder.DirectorySeparator"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The requested folder could not be found.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Check(System.Threading.CancellationToken)">
- <summary>
- Force the server to sync its in-memory state with its disk state.
- </summary>
- <remarks>
- <para>The <c>CHECK</c> command forces the IMAP server to sync its
- in-memory state with its disk state.</para>
- <para>For more information about the <c>CHECK</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.4.1">rfc350101</a>.</para>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CheckAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously force the server to sync its in-memory state with its disk state.
- </summary>
- <remarks>
- <para>The <c>CHECK</c> command forces the IMAP server to sync its
- in-memory state with its disk state.</para>
- <para>For more information about the <c>CHECK</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.4.1">rfc350101</a>.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)">
- <summary>
- Update the values of the specified items.
- </summary>
- <remarks>
- <para>Updates the values of the specified items.</para>
- <para>The <see cref="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
- MUST NOT be used on a folder that is already in the opened state. Instead, other ways
- of getting the desired information should be used.</para>
- <para>For example, a common use for the <see cref="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- method is to get the number of unread messages in the folder. When the folder is open, however, it is
- possible to use the <see cref="M:MailKit.Net.Imap.ImapFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
- method to query for the list of unread messages.</para>
- <para>For more information about the <c>STATUS</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.3.10">rfc3501</a>.</para>
- </remarks>
- <param name="items">The items to update.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the STATUS command.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously update the values of the specified items.
- </summary>
- <remarks>
- <para>Updates the values of the specified items.</para>
- <para>The <see cref="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
- MUST NOT be used on a folder that is already in the opened state. Instead, other ways
- of getting the desired information should be used.</para>
- <para>For example, a common use for the <see cref="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- method is to get the number of unread messages in the folder. When the folder is open, however, it is
- possible to use the <see cref="M:MailKit.Net.Imap.ImapFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
- method to query for the list of unread messages.</para>
- <para>For more information about the <c>STATUS</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.3.10">rfc3501</a>.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="items">The items to update.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the STATUS command.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetAccessControlList(System.Threading.CancellationToken)">
- <summary>
- Get the complete access control list for the folder.
- </summary>
- <remarks>
- Gets the complete access control list for the folder.
- </remarks>
- <returns>The access control list.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetAccessControlListAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the complete access control list for the folder.
- </summary>
- <remarks>
- Gets the complete access control list for the folder.
- </remarks>
- <returns>The access control list.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetAccessRights(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the access rights for a particular identifier.
- </summary>
- <remarks>
- Gets the access rights for a particular identifier.
- </remarks>
- <returns>The access rights.</returns>
- <param name="name">The identifier name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetAccessRightsAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for a particular identifier.
- </summary>
- <remarks>
- Gets the access rights for a particular identifier.
- </remarks>
- <returns>The access rights.</returns>
- <param name="name">The identifier name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMyAccessRights(System.Threading.CancellationToken)">
- <summary>
- Get the access rights for the current authenticated user.
- </summary>
- <remarks>
- Gets the access rights for the current authenticated user.
- </remarks>
- <returns>The access rights.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMyAccessRightsAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for the current authenticated user.
- </summary>
- <remarks>
- Gets the access rights for the current authenticated user.
- </remarks>
- <returns>The access rights.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Add access rights for the specified identity.
- </summary>
- <remarks>
- Adds the given access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- No rights were specified.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add access rights for the specified identity.
- </summary>
- <remarks>
- Adds the given access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- No rights were specified.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Remove access rights for the specified identity.
- </summary>
- <remarks>
- Removes the given access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- No rights were specified.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove access rights for the specified identity.
- </summary>
- <remarks>
- Removes the given access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- No rights were specified.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Set the access rights for the specified identity.
- </summary>
- <remarks>
- Sets the access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for the specified identity.
- </summary>
- <remarks>
- Sets the access rights for the specified identity.
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveAccess(System.String,System.Threading.CancellationToken)">
- <summary>
- Remove all access rights for the given identity.
- </summary>
- <remarks>
- Removes all access rights for the given identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveAccessAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove all access rights for the given identity.
- </summary>
- <remarks>
- Removes all access rights for the given identity.
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="name">The identity name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Set the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetQuota(System.Threading.CancellationToken)">
- <summary>
- Get the quota information for the folder.
- </summary>
- <remarks>
- <para>Gets the quota information for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.Net.Imap.ImapClient.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QUOTA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetQuotaAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the quota information for the folder.
- </summary>
- <remarks>
- <para>Gets the quota information for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.Net.Imap.ImapClient.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QUOTA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetQuota(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
- <summary>
- Set the quota limits for the folder.
- </summary>
- <remarks>
- <para>Sets the quota limits for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.Net.Imap.ImapClient.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
- <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QUOTA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetQuotaAsync(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the quota limits for the folder.
- </summary>
- <remarks>
- <para>Sets the quota limits for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.Net.Imap.ImapClient.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
- <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QUOTA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Expunge(System.Threading.CancellationToken)">
- <summary>
- Expunge the folder, permanently removing all messages marked for deletion.
- </summary>
- <remarks>
- <para>The <c>EXPUNGE</c> command permanently removes all messages in the folder
- that have the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.</para>
- <para>For more information about the <c>EXPUNGE</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.4.3">rfc3501</a>.</para>
- <note type="note">Normally, a <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted
- for each message that is expunged. However, if the IMAP server supports the QRESYNC extension
- and it has been enabled via the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>
- method, then the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than
- the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.ExpungeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously expunge the folder, permanently removing all messages marked for deletion.
- </summary>
- <remarks>
- <para>The <c>EXPUNGE</c> command permanently removes all messages in the folder
- that have the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.</para>
- <para>For more information about the <c>EXPUNGE</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.4.3">rfc3501</a>.</para>
- <note type="note">Normally, a <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted
- for each message that is expunged. However, if the IMAP server supports the QRESYNC extension
- and it has been enabled via the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>
- method, then the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than
- the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Expunge the specified uids, permanently removing them from the folder.
- </summary>
- <remarks>
- <para>Expunges the specified uids, permanently removing them from the folder.</para>
- <para>If the IMAP server supports the UIDPLUS extension (check the
- <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> for the <see cref="F:MailKit.Net.Imap.ImapCapabilities.UidPlus"/>
- flag), then this operation is atomic. Otherwise, MailKit implements this operation
- by first searching for the full list of message uids in the folder that are marked for
- deletion, unmarking the set of message uids that are not within the specified list of
- uids to be be expunged, expunging the folder (thus expunging the requested uids), and
- finally restoring the deleted flag on the collection of message uids that were originally
- marked for deletion that were not included in the list of uids provided. For this reason,
- it is advisable for clients that wish to maintain state to implement this themselves when
- the IMAP server does not support the UIDPLUS extension.</para>
- <para>For more information about the <c>UID EXPUNGE</c> command, see
- <a href="https://tools.ietf.org/html/rfc4315#section-2.1">rfc4315</a>.</para>
- <note type="note">Normally, a <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted
- for each message that is expunged. However, if the IMAP server supports the QRESYNC extension
- and it has been enabled via the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>
- method, then the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than
- the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <param name="uids">The message uids.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.ExpungeAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously expunge the specified uids, permanently removing them from the folder.
- </summary>
- <remarks>
- <para>Expunges the specified uids, permanently removing them from the folder.</para>
- <para>If the IMAP server supports the UIDPLUS extension (check the
- <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> for the <see cref="F:MailKit.Net.Imap.ImapCapabilities.UidPlus"/>
- flag), then this operation is atomic. Otherwise, MailKit implements this operation
- by first searching for the full list of message uids in the folder that are marked for
- deletion, unmarking the set of message uids that are not within the specified list of
- uids to be be expunged, expunging the folder (thus expunging the requested uids), and
- finally restoring the deleted flag on the collection of message uids that were originally
- marked for deletion that were not included in the list of uids provided. For this reason,
- it is advisable for clients that wish to maintain state to implement this themselves when
- the IMAP server does not support the UIDPLUS extension.</para>
- <para>For more information about the <c>UID EXPUNGE</c> command, see
- <a href="https://tools.ietf.org/html/rfc4315#section-2.1">rfc4315</a>.</para>
- <note type="note">Normally, a <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted
- for each message that is expunged. However, if the IMAP server supports the QRESYNC extension
- and it has been enabled via the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>
- method, then the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than
- the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The message uids.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages does not match the number of flags.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages does not match the number of flags.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="dates"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages, flags, and dates do not match.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="dates"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages, flags, and dates do not match.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CopyTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CopyToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.MoveTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified messages to the destination folder.
- </summary>
- <remarks>
- <para>Moves the specified messages to the destination folder.</para>
- <para>If the IMAP server supports the MOVE extension (check the <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/>
- property for the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Move"/> flag), then this operation will be atomic.
- Otherwise, MailKit implements this by first copying the messages to the destination folder, then
- marking them for deletion in the originating folder, and finally expunging them (see
- <see cref="M:MailKit.Net.Imap.ImapFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/> for more information about how a
- subset of messages are expunged). Since the server could disconnect at any point between those 3
- (or more) commands, it is advisable for clients to implement their own logic for moving messages when
- the IMAP server does not support the MOVE command in order to better handle spontanious server
- disconnects and other error conditions.</para>
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.MoveToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified messages to the destination folder.
- </summary>
- <remarks>
- <para>Moves the specified messages to the destination folder.</para>
- <para>If the IMAP server supports the MOVE extension (check the <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/>
- property for the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Move"/> flag), then this operation will be atomic.
- Otherwise, MailKit implements this by first copying the messages to the destination folder, then
- marking them for deletion in the originating folder, and finally expunging them (see
- <see cref="M:MailKit.Net.Imap.ImapFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/> for more information about how a
- subset of messages are expunged). Since the server could disconnect at any point between those 3
- (or more) commands, it is advisable for clients to implement their own logic for moving messages when
- the IMAP server does not support the MOVE command in order to better handle spontanious server
- disconnects and other error conditions.</para>
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CopyTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <param name="indexes">The indexes of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CopyToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="indexes">The indexes of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.MoveTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified messages to the destination folder.
- </summary>
- <remarks>
- <para>If the IMAP server supports the MOVE command, then the MOVE command will be used. Otherwise,
- the messages will first be copied to the destination folder and then marked as \Deleted in the
- originating folder. Since the server could disconnect at any point between those 2 operations, it
- may be advisable to implement your own logic for moving messages in this case in order to better
- handle spontanious server disconnects and other error conditions.</para>
- </remarks>
- <param name="indexes">The indexes of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.MoveToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified messages to the destination folder.
- </summary>
- <remarks>
- <para>If the IMAP server supports the MOVE command, then the MOVE command will be used. Otherwise,
- the messages will first be copied to the destination folder and then marked as \Deleted in the
- originating folder. Since the server could disconnect at any point between those 2 operations, it
- may be advisable to implement your own logic for moving messages in this case in order to better
- handle spontanious server disconnects and other error conditions.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="indexes">The indexes of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetEnumerator">
- <summary>
- Get an enumerator for the messages in the folder.
- </summary>
- <remarks>
- Gets an enumerator for the messages in the folder.
- </remarks>
- <returns>The enumerator.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages.
- </summary>
- <remarks>
- Stores the annotations for the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Store(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages.
- </summary>
- <remarks>
- Stores the annotations for the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Store(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.s
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the IMAP server supports the QRESYNC extension and the application has
- enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
- that have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the IMAP server supports the QRESYNC extension and the application has
- enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
- that have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the IMAP server supports the QRESYNC extension and the application has
- enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
- that have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the IMAP server supports the QRESYNC extension and the application has
- enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
- that have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the IMAP server supports the QRESYNC extension and the application has
- enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
- that have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the IMAP server supports the QRESYNC extension and the application has
- enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
- that have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)">
- <summary>
- Create a backing stream for use with the GetMessage, GetBodyPart, and GetStream methods.
- </summary>
- <remarks>
- <para>Allows subclass implementations to override the type of stream
- created for use with the GetMessage, GetBodyPart and GetStream methods.</para>
- <para>This could be useful for subclass implementations that intend to implement
- support for caching and/or for subclass implementations that want to use
- temporary file streams instead of memory-based streams for larger amounts of
- message data.</para>
- <para>Subclasses that implement caching using this API should wait for
- <see cref="M:MailKit.Net.Imap.ImapFolder.CommitStream(System.IO.Stream,MailKit.UniqueId,System.String,System.Int32,System.Int32)"/> before adding the stream to their cache.</para>
- <para>Streams returned by this method SHOULD clean up any allocated resources
- such as deleting temporary files from the file system.</para>
- <note type="note">The <paramref name="uid"/> will not be available for the various
- GetMessage(), GetBodyPart() and GetStream() methods that take a message index rather
- than a <see cref="T:MailKit.UniqueId"/>. It may also not be available if the IMAP server
- response does not specify the <c>UID</c> value prior to sending the <c>literal-string</c>
- token containing the message stream.</note>
- </remarks>
- <seealso cref="M:MailKit.Net.Imap.ImapFolder.CommitStream(System.IO.Stream,MailKit.UniqueId,System.String,System.Int32,System.Int32)"/>
- <returns>The stream.</returns>
- <param name="uid">The unique identifier of the message, if available.</param>
- <param name="section">The section of the message that is being fetched.</param>
- <param name="offset">The starting offset of the message section being fetched.</param>
- <param name="length">The length of the stream being fetched, measured in bytes.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CommitStream(System.IO.Stream,MailKit.UniqueId,System.String,System.Int32,System.Int32)">
- <summary>
- Commit a stream returned by <see cref="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)"/>.
- </summary>
- <remarks>
- <para>Commits a stream returned by <see cref="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)"/>.</para>
- <para>This method is called only after both the message data has successfully
- been written to the stream returned by <see cref="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)"/> and a
- <see cref="T:MailKit.UniqueId"/> has been obtained for the associated message.</para>
- <para>For subclasses implementing caching, this method should be used for
- committing the stream to their cache.</para>
- <note type="note">Subclass implementations may take advantage of the fact that
- <see cref="M:MailKit.Net.Imap.ImapFolder.CommitStream(System.IO.Stream,MailKit.UniqueId,System.String,System.Int32,System.Int32)"/> allows returning a new <see cref="T:System.IO.Stream"/>
- reference if they move a file on the file system and wish to return a new
- <see cref="T:System.IO.FileStream"/> based on the new path, for example.</note>
- </remarks>
- <seealso cref="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)"/>
- <returns>The stream.</returns>
- <param name="stream">The stream.</param>
- <param name="uid">The unique identifier of the message.</param>
- <param name="section">The section of the message that the stream represents.</param>
- <param name="offset">The starting offset of the message section.</param>
- <param name="length">The length of the stream, measured in bytes.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMessageAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPart(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPartAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPart(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPartAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPart(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPartAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPart(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPartAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- Fetches a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously gets a substream of the specified message.
- </summary>
- <remarks>
- Fetches a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- Fetches a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously gets a substream of the specified message.
- </summary>
- <remarks>
- Fetches a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified body part.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously gets a substream of the specified body part.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously gets a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously gets a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously gets a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreams(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Gets the streams for the specified messages.</para>
- </remarks>
- <param name="uids">The uids of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Asynchronously gets the streams for the specified messages.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="uids">The uids of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreams(System.Collections.Generic.IList{System.Int32},MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Gets the streams for the specified messages.</para>
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Asynchronously gets the streams for the specified messages.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreams(System.Int32,System.Int32,MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Gets the streams for the specified messages.</para>
- </remarks>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="callback"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamsAsync(System.Int32,System.Int32,MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Asynchronously gets the streams for the specified messages.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="callback"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Adds a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously adds a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Removes a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously removes a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Sets the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Adds a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously adds a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Removes a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously removes a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Sets the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Sets the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Search(System.String,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SEARCH</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SEARCH</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SearchAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SEARCH</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SEARCH</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SearchAsync(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Search(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The IMAP server does not support the ESEARCH extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SearchAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The IMAP server does not support the ESEARCH extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Sort(System.String,System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SORT</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SORT</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the SORT extension.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SortAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SORT</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SORT</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the SORT extension.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The server does not support the SORT extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SortAsync(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The server does not support the SORT extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Sort(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The IMAP server does not support the ESORT extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SortAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The IMAP server does not support the ESORT extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Thread(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The server does not support the THREAD extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.ThreadAsync(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The server does not support the THREAD extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Thread(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The server does not support the THREAD extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.ThreadAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The server does not support the THREAD extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="T:MailKit.Net.Imap.ImapFolderConstructorArgs">
- <summary>
- Constructor arguments for <see cref="T:MailKit.Net.Imap.ImapFolder"/>.
- </summary>
- <remarks>
- Constructor arguments for <see cref="T:MailKit.Net.Imap.ImapFolder"/>.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolderConstructorArgs.#ctor(MailKit.Net.Imap.ImapEngine,System.String,MailKit.FolderAttributes,System.Char)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapFolderConstructorArgs"/> class.
- </summary>
- <param name="engine">The IMAP command engine.</param>
- <param name="encodedName">The encoded name.</param>
- <param name="attributes">The attributes.</param>
- <param name="delim">The directory separator.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolderConstructorArgs.Attributes">
- <summary>
- Get the folder attributes.
- </summary>
- <remarks>
- Gets the folder attributes.
- </remarks>
- <value>The folder attributes.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolderConstructorArgs.DirectorySeparator">
- <summary>
- Get the directory separator.
- </summary>
- <remarks>
- Gets the directory separator.
- </remarks>
- <value>The directory separator.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolderConstructorArgs.FullName">
- <summary>
- Get the full name of the folder.
- </summary>
- <remarks>
- This is the equivalent of the full path of a file on a file system.
- </remarks>
- <value>The full name of the folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolderConstructorArgs.Name">
- <summary>
- Get the name of the folder.
- </summary>
- <remarks>
- This is the equivalent of the file name of a file on the file system.
- </remarks>
- <value>The name of the folder.</value>
- </member>
- <member name="T:MailKit.Net.Imap.ImapImplementation">
- <summary>
- The details of an IMAP client or server implementation.
- </summary>
- <remarks>
- Allows an IMAP client and server to share their implementation details
- with each other for the purposes of debugging.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Imap.ImapImplementation.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapImplementation"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapImplementation"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Properties">
- <summary>
- Get the identification properties.
- </summary>
- <remarks>
- Gets the dictionary of raw identification properties.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The properties.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Name">
- <summary>
- Get or set the name of the program.
- </summary>
- <remarks>
- Gets or sets the name of the program.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The program name.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Version">
- <summary>
- Get or set the version of the program.
- </summary>
- <remarks>
- Gets or sets the version of the program.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The program version.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.OS">
- <summary>
- Get or set the name of the operating system.
- </summary>
- <remarks>
- Gets or sets the name of the operating system.
- </remarks>
- <value>The name of the operation system.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.OSVersion">
- <summary>
- Get or set the version of the operating system.
- </summary>
- <remarks>
- Gets or sets the version of the operating system.
- </remarks>
- <value>The version of the operation system.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Vendor">
- <summary>
- Get or set the name of the vendor.
- </summary>
- <remarks>
- Gets or sets the name of the vendor.
- </remarks>
- <value>The name of the vendor.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.SupportUrl">
- <summary>
- Get or set the support URL.
- </summary>
- <remarks>
- Gets or sets the support URL.
- </remarks>
- <value>The support URL.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Address">
- <summary>
- Get or set the postal address of the vendor.
- </summary>
- <remarks>
- Gets or sets the postal address of the vendor.
- </remarks>
- <value>The postal address.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.ReleaseDate">
- <summary>
- Get or set the release date of the program.
- </summary>
- <remarks>
- Gets or sets the release date of the program.
- </remarks>
- <value>The release date.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Command">
- <summary>
- Get or set the command used to start the program.
- </summary>
- <remarks>
- Gets or sets the command used to start the program.
- </remarks>
- <value>The command used to start the program.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Arguments">
- <summary>
- Get or set the command-line arguments used to start the program.
- </summary>
- <remarks>
- Gets or sets the command-line arguments used to start the program.
- </remarks>
- <value>The command-line arguments used to start the program.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Environment">
- <summary>
- Get or set the environment variables available to the program.
- </summary>
- <remarks>
- Get or set the environment variables available to the program.
- </remarks>
- <value>The environment variables.</value>
- </member>
- <member name="T:MailKit.Net.Imap.ImapProtocolException">
- <summary>
- An IMAP protocol exception.
- </summary>
- <remarks>
- The exception that is thrown when there is an error communicating with an IMAP server. An
- <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> is typically fatal and requires the <see cref="T:MailKit.Net.Imap.ImapClient"/>
- to be reconnected.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapProtocolException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> from the serialized data.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapProtocolException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapProtocolException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapProtocolException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapProtocolException"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Imap.ImapProtocolException.UnexpectedToken">
- <summary>
- Gets or sets whether or not this exception was thrown due to an unexpected token.
- </summary>
- <remarks>
- Gets or sets whether or not this exception was thrown due to an unexpected token.
- </remarks>
- <value><c>true</c> if an unexpected token was encountered; otherwise, <c>false</c>.</value>
- </member>
- <member name="T:MailKit.Net.Imap.ImapStreamMode">
- <summary>
- An enumeration of the possible IMAP streaming modes.
- </summary>
- <remarks>
- Normal operation is done in the <see cref="F:MailKit.Net.Imap.ImapStreamMode.Token"/> mode,
- but when reading literal string data, the
- <see cref="F:MailKit.Net.Imap.ImapStreamMode.Literal"/> mode should be used.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapStreamMode.Token">
- <summary>
- Reads 1 token at a time.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapStreamMode.Literal">
- <summary>
- Reads literal string data.
- </summary>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.#ctor(System.IO.Stream,MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapStream"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapStream"/>.
- </remarks>
- <param name="source">The underlying network stream.</param>
- <param name="protocolLogger">The protocol logger.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.Stream">
- <summary>
- Get or sets the underlying network stream.
- </summary>
- <remarks>
- Gets or sets the underlying network stream.
- </remarks>
- <value>The underlying network stream.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.Mode">
- <summary>
- Get or sets the mode used for reading.
- </summary>
- <remarks>
- Gets or sets the mode used for reading.
- </remarks>
- <value>The mode.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.LiteralLength">
- <summary>
- Get the length of the literal.
- </summary>
- <remarks>
- Gets the length of the literal.
- </remarks>
- <value>The length of the literal.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.IsConnected">
- <summary>
- Get whether or not the stream is connected.
- </summary>
- <remarks>
- Gets whether or not the stream is connected.
- </remarks>
- <value><c>true</c> if the stream is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.CanRead">
- <summary>
- Get whether the stream supports reading.
- </summary>
- <remarks>
- Gets whether the stream supports reading.
- </remarks>
- <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.CanWrite">
- <summary>
- Get whether the stream supports writing.
- </summary>
- <remarks>
- Gets whether the stream supports writing.
- </remarks>
- <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.CanSeek">
- <summary>
- Get whether the stream supports seeking.
- </summary>
- <remarks>
- Gets whether the stream supports seeking.
- </remarks>
- <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.CanTimeout">
- <summary>
- Get whether the stream supports I/O timeouts.
- </summary>
- <remarks>
- Gets whether the stream supports I/O timeouts.
- </remarks>
- <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.ReadTimeout">
- <summary>
- Get or set a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
- </summary>
- <remarks>
- Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
- </remarks>
- <returns>A value, in milliseconds, that determines how long the stream will attempt to read before timing out.</returns>
- <value>The read timeout.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.WriteTimeout">
- <summary>
- Get or set a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
- </summary>
- <remarks>
- Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
- </remarks>
- <returns>A value, in milliseconds, that determines how long the stream will attempt to write before timing out.</returns>
- <value>The write timeout.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.Position">
- <summary>
- Get or set the position within the current stream.
- </summary>
- <remarks>
- Gets or sets the position within the current stream.
- </remarks>
- <returns>The current position within the stream.</returns>
- <value>The position of the stream.</value>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.Length">
- <summary>
- Get the length of the stream, in bytes.
- </summary>
- <remarks>
- Gets the length of the stream, in bytes.
- </remarks>
- <returns>A long value representing the length of the stream in bytes.</returns>
- <value>The length of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Read(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The stream is in token mode (see <see cref="F:MailKit.Net.Imap.ImapStreamMode.Token"/>).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The stream is in token mode (see <see cref="F:MailKit.Net.Imap.ImapStreamMode.Token"/>).
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.ReadToken(System.Threading.CancellationToken)">
- <summary>
- Reads the next available token from the stream.
- </summary>
- <returns>The token.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.ReadTokenAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously reads the next available token from the stream.
- </summary>
- <returns>The token.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.UngetToken(MailKit.Net.Imap.ImapToken)">
- <summary>
- Ungets a token.
- </summary>
- <param name="token">The token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.ReadLine(System.IO.Stream,System.Threading.CancellationToken)">
- <summary>
- Reads a single line of input from the stream.
- </summary>
- <remarks>
- This method should be called in a loop until it returns <c>true</c>.
- </remarks>
- <returns><c>true</c>, if reading the line is complete, <c>false</c> otherwise.</returns>
- <param name="ostream">The output stream to write the line data into.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.ReadLineAsync(System.IO.Stream,System.Threading.CancellationToken)">
- <summary>
- Asynchronously reads a single line of input from the stream.
- </summary>
- <remarks>
- This method should be called in a loop until it returns <c>true</c>.
- </remarks>
- <returns><c>true</c>, if reading the line is complete, <c>false</c> otherwise.</returns>
- <param name="ostream">The output stream to write the line data into.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Write(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <returns>A task that represents the asynchronous write operation.</returns>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Flush(System.Threading.CancellationToken)">
- <summary>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Flush">
- <summary>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.FlushAsync(System.Threading.CancellationToken)">
- <summary>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <returns>A task that represents the asynchronous flush operation.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- Sets the position within the current stream.
- </summary>
- <remarks>
- It is not possible to seek within a <see cref="T:MailKit.Net.Imap.ImapStream"/>.
- </remarks>
- <returns>The new position within the stream.</returns>
- <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
- <param name="origin">The origin to seek from.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.SetLength(System.Int64)">
- <summary>
- Sets the length of the stream.
- </summary>
- <remarks>
- It is not possible to set the length of a <see cref="T:MailKit.Net.Imap.ImapStream"/>.
- </remarks>
- <param name="value">The desired length of the stream in bytes.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support setting the length.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Imap.ImapStream"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Imap.ImapStream"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapUtils">
- <summary>
- IMAP utility functions.
- </summary>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.FormatInternalDate(System.DateTimeOffset)">
- <summary>
- Formats a date in a format suitable for use with the APPEND command.
- </summary>
- <returns>The formatted date string.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseInternalDate(System.String)">
- <summary>
- Parses the internal date string.
- </summary>
- <returns>The date.</returns>
- <param name="text">The text to parse.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.FormatAnnotations(System.Text.StringBuilder,System.Collections.Generic.IList{MailKit.Annotation},System.Collections.Generic.List{System.Object},System.Boolean)">
- <summary>
- Formats a list of annotations for a STORE or APPEND command.
- </summary>
- <param name="command">The command builder.</param>
- <param name="annotations">The annotations.</param>
- <param name="args">the argument list.</param>
- <param name="throwOnError">Throw an exception if there are any annotations without properties.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.FormatIndexSet(System.Collections.Generic.IList{System.Int32})">
- <summary>
- Formats the array of indexes as a string suitable for use with IMAP commands.
- </summary>
- <returns>The index set.</returns>
- <param name="indexes">The indexes.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- One or more of the indexes has a negative value.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseImplementationAsync(MailKit.Net.Imap.ImapEngine,MailKit.Net.Imap.ImapCommand,System.Int32,System.Boolean)">
- <summary>
- Parses an untagged ID response.
- </summary>
- <param name="engine">The IMAP engine.</param>
- <param name="ic">The IMAP command.</param>
- <param name="index">The index.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.CanonicalizeMailboxName(System.String,System.Char)">
- <summary>
- Canonicalize the name of the mailbox.
- </summary>
- <remarks>
- Canonicalizes the name of the mailbox by replacing various
- capitalizations of "INBOX" with the literal "INBOX" string.
- </remarks>
- <returns>The mailbox name.</returns>
- <param name="mailboxName">The encoded mailbox name.</param>
- <param name="directorySeparator">The directory separator.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.IsInbox(System.String)">
- <summary>
- Determines whether the specified mailbox is the Inbox.
- </summary>
- <returns><c>true</c> if the specified mailbox name is the Inbox; otherwise, <c>false</c>.</returns>
- <param name="mailboxName">The mailbox name.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseFolderListAsync(MailKit.Net.Imap.ImapEngine,System.Collections.Generic.List{MailKit.Net.Imap.ImapFolder},System.Boolean,System.Boolean,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses an untagged LIST or LSUB response.
- </summary>
- <param name="engine">The IMAP engine.</param>
- <param name="list">The list of folders to be populated.</param>
- <param name="isLsub"><c>true</c> if it is an LSUB response; otherwise, <c>false</c>.</param>
- <param name="returnsSubscribed"><c>true</c> if the LIST response is expected to return \Subscribed flags; otherwise, <c>false</c>.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseFolderListAsync(MailKit.Net.Imap.ImapEngine,MailKit.Net.Imap.ImapCommand,System.Int32,System.Boolean)">
- <summary>
- Parses an untagged LIST or LSUB response.
- </summary>
- <param name="engine">The IMAP engine.</param>
- <param name="ic">The IMAP command.</param>
- <param name="index">The index.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseMetadataAsync(MailKit.Net.Imap.ImapEngine,MailKit.MetadataCollection,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses an untagged METADATA response.
- </summary>
- <returns>The encoded name of the folder that the metadata belongs to.</returns>
- <param name="engine">The IMAP engine.</param>
- <param name="metadata">The metadata collection to be populated.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseMetadataAsync(MailKit.Net.Imap.ImapEngine,MailKit.Net.Imap.ImapCommand,System.Int32,System.Boolean)">
- <summary>
- Parses an untagged METADATA response.
- </summary>
- <param name="engine">The IMAP engine.</param>
- <param name="ic">The IMAP command.</param>
- <param name="index">The index.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseEnvelopeAsync(MailKit.Net.Imap.ImapEngine,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses the ENVELOPE parenthesized list.
- </summary>
- <returns>The envelope.</returns>
- <param name="engine">The IMAP engine.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.FormatFlagsList(MailKit.MessageFlags,System.Int32)">
- <summary>
- Formats a flags list suitable for use with the APPEND command.
- </summary>
- <returns>The flags list string.</returns>
- <param name="flags">The message flags.</param>
- <param name="numUserFlags">The number of user-defined flags.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseFlagsListAsync(MailKit.Net.Imap.ImapEngine,System.String,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses the flags list.
- </summary>
- <returns>The message flags.</returns>
- <param name="engine">The IMAP engine.</param>
- <param name="name">The name of the flags being parsed.</param>
- <param name="keywords">A hash set of user-defined message flags that will be populated if non-null.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseAnnotationsAsync(MailKit.Net.Imap.ImapEngine,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses the ANNOTATION list.
- </summary>
- <returns>The list of annotations.</returns>
- <param name="engine">The IMAP engine.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseLabelsListAsync(MailKit.Net.Imap.ImapEngine,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses the X-GM-LABELS list.
- </summary>
- <returns>The message labels.</returns>
- <param name="engine">The IMAP engine.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseThreadsAsync(MailKit.Net.Imap.ImapEngine,System.UInt32,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses the threads.
- </summary>
- <returns>The threads.</returns>
- <param name="engine">The IMAP engine.</param>
- <param name="uidValidity">The UIDVALIDITY of the folder.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3Client">
- <summary>
- A POP3 client that can be used to retrieve messages from a server.
- </summary>
- <remarks>
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> class supports both the "pop" and "pops" protocols. The "pop" protocol
- makes a clear-text connection to the POP3 server and does not use SSL or TLS unless the POP3 server
- supports the <a href="https://tools.ietf.org/html/rfc2595">STLS</a> extension. The "pops" protocol,
- however, connects to the POP3 server using an SSL-wrapped connection.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- An POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticates using the supplied credentials.
- </summary>
- <remarks>
- <para>If the POP3 server supports the APOP authentication mechanism,
- then APOP is used.</para>
- <para>If the APOP authentication mechanism is not supported and the
- server supports one or more SASL authentication mechanisms, then
- the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the <c>USER</c> and <c>PASS</c> commands are used as a
- fallback.</para>
- <note type="tip"><para>To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> hash set
- before calling this method.</para>
- <para>In the case of the APOP authentication mechanism, remove it from the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property instead.</para></note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The text encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- An POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified POP3 or POP3/S server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified POP3 or POP3/S server.</para>
- <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
- <paramref name="options"/> parameter is used to determine the default port to
- connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
- is <c>995</c>. All other values will use a default port of <c>110</c>.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>995</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
- populated.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the POP3 server does not support the STLS extension.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified POP3 or POP3/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified POP3 or POP3/S server using
- the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>995</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the POP3 server does not support the STLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified POP3 or POP3/S server using the provided stream.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified POP3 or POP3/S server using
- the provided stream.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>995</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="stream">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the POP3 server does not support the STLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="quit">If set to <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageCountAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the message count.
- </summary>
- <remarks>
- Asynchronously gets the message count.
- </remarks>
- <returns>The message count.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.NoOpAsync(System.Threading.CancellationToken)">
- <summary>
- Ping the POP3 server to keep the connection alive.
- </summary>
- <remarks>Mail servers, if left idle for too long, will automatically drop the connection.</remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.EnableUTF8Async(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable UTF8 mode.
- </summary>
- <remarks>
- The POP3 UTF8 extension allows the client to retrieve messages in the UTF-8 encoding and
- may also allow the user to authenticate using a UTF-8 encoded username or password.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has already been authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UTF8 extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetLanguagesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the list of languages supported by the POP3 server.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- query the list of languages supported by the POP3 server that can
- be used for error messages.
- </remarks>
- <returns>The supported languages.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.SetLanguageAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the language used by the POP3 server for error messages.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- set the language used by the POP3 server for error messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="lang">The language code.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="lang"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="lang"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageUidAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the UID of the message at the specified index.
- </summary>
- <remarks>
- <para>Gets the UID of the message at the specified index.</para>
- <note type="warning">Not all servers support UIDs, so you should first check the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property for the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL"/> flag or
- the <see cref="P:MailKit.Net.Pop3.Pop3Client.SupportsUids"/> convenience property.</note>
- </remarks>
- <returns>The message UID.</returns>
- <param name="index">The message index.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageUidsAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the full list of available message UIDs.
- </summary>
- <remarks>
- <para>Gets the full list of available message UIDs.</para>
- <note type="warning">Not all servers support UIDs, so you should first check the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property for the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL"/> flag or
- the <see cref="P:MailKit.Net.Pop3.Pop3Client.SupportsUids"/> convenience property.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadNewMessages"/>
- </example>
- <returns>The message uids.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageSizeAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the size of the specified message, in bytes.
- </summary>
- <remarks>
- Gets the size of the specified message, in bytes.
- </remarks>
- <returns>The message size, in bytes.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageSizesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the sizes for all available messages, in bytes.
- </summary>
- <remarks>
- Gets the sizes for all available messages, in bytes.
- </remarks>
- <returns>The message sizes, in bytes.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeadersAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers for the message at the specified index.
- </summary>
- <remarks>
- Gets the headers for the message at the specified index.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeadersAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers for the messages at the specified indexes.
- </summary>
- <remarks>
- <para>Gets the headers for the messages at the specified indexes.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)"/> for each message because
- it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The headers for the specified messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeadersAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers of the messages within the specified range.
- </summary>
- <remarks>
- <para>Gets the headers of the messages within the specified range.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)"/> for each message because
- it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The headers of the messages within the specified range.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message at the specified index.
- </summary>
- <remarks>
- Gets the message at the specified index.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the messages at the specified indexes.
- </summary>
- <remarks>
- <para>Gets the messages at the specified indexes.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the messages within the specified range.
- </summary>
- <remarks>
- <para>Gets the messages within the specified range.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
- </example>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreamAsync(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header stream at the specified index.
- </summary>
- <remarks>
- Gets the message or header stream at the specified index.
- </remarks>
- <returns>The message or header stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header streams at the specified indexes.
- </summary>
- <remarks>
- <para>Get the message or header streams at the specified indexes.</para>
- <para>If the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreamsAsync(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header streams within the specified range.
- </summary>
- <remarks>
- <para>Gets the message or header streams within the specified range.</para>
- <para>If the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="startIndex">The index of the first stream to get.</param>
- <param name="count">The number of streams to get.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessageAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified message for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified range of messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="startIndex">The index of the first message to mark for deletion.</param>
- <param name="count">The number of messages to mark for deletion.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteAllMessagesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark all messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.ResetAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously reset the state of all messages marked for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> class.
- </summary>
- <remarks>
- Before you can retrieve messages with the <see cref="T:MailKit.Net.Pop3.Pop3Client"/>, you must first call
- one of the <a href="Overload_MailKit_Net_Pop3_Pop3Client_Connect.htm">Connect</a> methods
- and authenticate using one of the
- <a href="Overload_MailKit_Net_Pop3_Pop3Client_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="ProtocolLogger"/>
- </example>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> class.
- </summary>
- <remarks>
- Before you can retrieve messages with the <see cref="T:MailKit.Net.Pop3.Pop3Client"/>, you must first call
- one of the <a href="Overload_MailKit_Net_Pop3_Pop3Client_Connect.htm">Connect</a> methods
- and authenticate using one of the
- <a href="Overload_MailKit_Net_Pop3_Pop3Client_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the POP3 server.
- </summary>
- <remarks>
- <para>Gets an object that can be used to synchronize access to the POP3 server.</para>
- <para>When using the non-Async methods from multiple threads, it is important to lock the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.SyncRoot"/> object for thread safety when using the synchronous methods.</para>
- </remarks>
- <value>The lock object.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.Protocol">
- <summary>
- Gets the protocol supported by the message service.
- </summary>
- <remarks>
- Gets the protocol supported by the message service.
- </remarks>
- <value>The protocol.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.Capabilities">
- <summary>
- Gets the capabilities supported by the POP3 server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection has been made
- and may change once the client is authenticated.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The capabilities.</value>
- <exception cref="T:System.ArgumentException">
- Capabilities cannot be enabled, they may only be disabled.
- </exception>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.ExpirePolicy">
- <summary>
- Gets the expiration policy.
- </summary>
- <remarks>
- <para>If the server supports the EXPIRE capability (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Expire"/>), the value
- of the <see cref="P:MailKit.Net.Pop3.Pop3Client.ExpirePolicy"/> property will reflect the value advertized by the server.</para>
- <para>A value of <c>-1</c> indicates that messages will never expire.</para>
- <para>A value of <c>0</c> indicates that messages that have been retrieved during the current session
- will be purged immediately after the connection is closed via the <c>QUIT</c> command.</para>
- <para>Values larger than <c>0</c> indicate the minimum number of days that the server will retain
- messages which have been retrieved.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The expiration policy.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.Implementation">
- <summary>
- Gets the implementation details of the server.
- </summary>
- <remarks>
- If the server advertizes its implementation details, this value will be set to a string containing the
- information details provided by the server.
- </remarks>
- <value>The implementation details.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.LoginDelay">
- <summary>
- Gets the minimum delay, in milliseconds, between logins.
- </summary>
- <remarks>
- If the server supports the LOGIN-DELAY capability (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.LoginDelay"/>), this value
- will be set to the minimum number of milliseconds that the client must wait between logins.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The login delay.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms">
- <summary>
- Gets the authentication mechanisms supported by the POP3 server.
- </summary>
- <remarks>
- <para>The authentication mechanisms are queried as part of the
- connection process.</para>
- <para>Servers that do not support the SASL capability will typically
- support either the <c>APOP</c> authentication mechanism
- (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Apop"/>) or the ability to login using the
- <c>USER</c> and <c>PASS</c> commands (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.User"/>).
- </para>
- <note type="tip"><para>To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> hash set
- before authenticating.</para>
- <para>In the case of the APOP authentication mechanism, remove it from the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property instead.</para></note>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.Timeout">
- <summary>
- Gets or sets the timeout for network streaming operations, in milliseconds.
- </summary>
- <remarks>
- Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
- and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
- </remarks>
- <value>The timeout in milliseconds.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.IsConnected">
- <summary>
- Gets whether or not the client is currently connected to an POP3 server.
- </summary>
- <remarks>
- <para>The <see cref="P:MailKit.Net.Pop3.Pop3Client.IsConnected"/> state is set to <c>true</c> immediately after
- one of the <a href="Overload_MailKit_Net_Pop3_Pop3Client_Connect.htm">Connect</a>
- methods succeeds and is not set back to <c>false</c> until either the client
- is disconnected via <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until a
- <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> is thrown while attempting to read or write to
- the underlying network socket.</para>
- <para>When an <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> is caught, the connection state of the
- <see cref="T:MailKit.Net.Pop3.Pop3Client"/> should be checked before continuing.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="ExceptionHandling"/>
- </example>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.IsSecure">
- <summary>
- Get whether or not the connection is secure (typically via SSL or TLS).
- </summary>
- <remarks>
- Gets whether or not the connection is secure (typically via SSL or TLS).
- </remarks>
- <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.IsAuthenticated">
- <summary>
- Get whether or not the client is currently authenticated with the POP3 server.
- </summary>
- <remarks>
- <para>Gets whether or not the client is currently authenticated with the POP3 server.</para>
- <para>To authenticate with the POP3 server, use one of the
- <a href="Overload_MailKit_Net_Pop3_Pop3Client_Authenticate.htm">Authenticate</a> methods.</para>
- </remarks>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- An POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the POP3 server supports the APOP authentication mechanism,
- then APOP is used.</para>
- <para>If the APOP authentication mechanism is not supported and the
- server supports one or more SASL authentication mechanisms, then
- the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the <c>USER</c> and <c>PASS</c> commands are used as a
- fallback.</para>
- <note type="tip"><para>To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> hash set
- before calling this method.</para>
- <para>In the case of the APOP authentication mechanism, remove it from the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property instead.</para></note>
- </remarks>
- <param name="encoding">The text encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- An POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified POP3 or POP3/S server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified POP3 or POP3/S server.</para>
- <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
- <paramref name="options"/> parameter is used to determine the default port to
- connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
- is <c>995</c>. All other values will use a default port of <c>110</c>.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>995</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
- populated.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the POP3 server does not support the STLS extension.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified POP3 or POP3/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified POP3 or POP3/S server using
- the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>995</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the POP3 server does not support the STLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified POP3 or POP3/S server using the provided stream.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified POP3 or POP3/S server using
- the provided stream.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>995</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the POP3 server does not support the STLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <param name="quit">If set to <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageCount(System.Threading.CancellationToken)">
- <summary>
- Get the message count.
- </summary>
- <remarks>
- Gets the message count.
- </remarks>
- <returns>The message count.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.NoOp(System.Threading.CancellationToken)">
- <summary>
- Ping the POP3 server to keep the connection alive.
- </summary>
- <remarks>Mail servers, if left idle for too long, will automatically drop the connection.</remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.EnableUTF8(System.Threading.CancellationToken)">
- <summary>
- Enable UTF8 mode.
- </summary>
- <remarks>
- The POP3 UTF8 extension allows the client to retrieve messages in the UTF-8 encoding and
- may also allow the user to authenticate using a UTF-8 encoded username or password.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has already been authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UTF8 extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetLanguages(System.Threading.CancellationToken)">
- <summary>
- Get the list of languages supported by the POP3 server.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- query the list of languages supported by the POP3 server that can
- be used for error messages.
- </remarks>
- <returns>The supported languages.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.SetLanguage(System.String,System.Threading.CancellationToken)">
- <summary>
- Set the language used by the POP3 server for error messages.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- set the language used by the POP3 server for error messages.
- </remarks>
- <param name="lang">The language code.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="lang"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="lang"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.Count">
- <summary>
- Get the number of messages available in the message spool.
- </summary>
- <remarks>
- <para>Gets the number of messages available on the POP3 server.</para>
- <para>Once authenticated, the <see cref="P:MailKit.Net.Pop3.Pop3Client.Count"/> property will be set
- to the number of available messages on the POP3 server.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <value>The message count.</value>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.SupportsUids">
- <summary>
- Gets whether or not the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> supports referencing messages by UIDs.
- </summary>
- <remarks>
- <para>Not all servers support referencing messages by UID, so this property should
- be checked before using <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/>
- and <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageUids(System.Threading.CancellationToken)"/>.</para>
- <para>If the server does not support UIDs, then all methods that take UID arguments
- along with <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/> and
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageUids(System.Threading.CancellationToken)"/> will fail.</para>
- </remarks>
- <value><c>true</c> if supports UIDs; otherwise, <c>false</c>.</value>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageUid(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the UID of the message at the specified index.
- </summary>
- <remarks>
- <para>Gets the UID of the message at the specified index.</para>
- <note type="warning">Not all servers support UIDs, so you should first check the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property for the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL"/> flag or
- the <see cref="P:MailKit.Net.Pop3.Pop3Client.SupportsUids"/> convenience property.</note>
- </remarks>
- <returns>The message UID.</returns>
- <param name="index">The message index.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageUids(System.Threading.CancellationToken)">
- <summary>
- Get the full list of available message UIDs.
- </summary>
- <remarks>
- <para>Gets the full list of available message UIDs.</para>
- <note type="warning">Not all servers support UIDs, so you should first check the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property for the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL"/> flag or
- the <see cref="P:MailKit.Net.Pop3.Pop3Client.SupportsUids"/> convenience property.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadNewMessages"/>
- </example>
- <returns>The message uids.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageSize(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the size of the specified message, in bytes.
- </summary>
- <remarks>
- Gets the size of the specified message, in bytes.
- </remarks>
- <returns>The message size, in bytes.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageSizes(System.Threading.CancellationToken)">
- <summary>
- Get the sizes for all available messages, in bytes.
- </summary>
- <remarks>
- Gets the sizes for all available messages, in bytes.
- </remarks>
- <returns>The message sizes, in bytes.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers for the message at the specified index.
- </summary>
- <remarks>
- Gets the headers for the message at the specified index.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Get the headers for the messages at the specified indexes.
- </summary>
- <remarks>
- <para>Gets the headers for the messages at the specified indexes.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)"/> for each message because
- it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The headers for the specified messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers of the messages within the specified range.
- </summary>
- <remarks>
- <para>Gets the headers of the messages within the specified range.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)"/> for each message because
- it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The headers of the messages within the specified range.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message at the specified index.
- </summary>
- <remarks>
- Gets the message at the specified index.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the messages at the specified indexes.
- </summary>
- <remarks>
- <para>Gets the messages at the specified indexes.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessages(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the messages within the specified range.
- </summary>
- <remarks>
- <para>Gets the messages within the specified range.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
- </example>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header stream at the specified index.
- </summary>
- <remarks>
- Gets the message or header stream at the specified index.
- </remarks>
- <returns>The message or header stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreams(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header streams at the specified indexes.
- </summary>
- <remarks>
- <para>Get the message or header streams at the specified indexes.</para>
- <para>If the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreams(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header streams within the specified range.
- </summary>
- <remarks>
- <para>Gets the message or header streams within the specified range.</para>
- <para>If the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="startIndex">The index of the first stream to get.</param>
- <param name="count">The number of streams to get.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessage(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Mark the specified message for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Mark the specified messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessages(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Mark the specified range of messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
- </example>
- <param name="startIndex">The index of the first message to mark for deletion.</param>
- <param name="count">The number of messages to mark for deletion.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteAllMessages(System.Threading.CancellationToken)">
- <summary>
- Mark all messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Reset(System.Threading.CancellationToken)">
- <summary>
- Reset the state of all messages marked for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetEnumerator">
- <summary>
- Get an enumerator for the messages in the folder.
- </summary>
- <remarks>
- Gets an enumerator for the messages in the folder.
- </remarks>
- <returns>The enumerator.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Net.Pop3.IPop3Client">
- <summary>
- An interface for a POP3 client.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Pop3.Pop3Client"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Pop3.IPop3Client.Capabilities">
- <summary>
- Gets the capabilities supported by the POP3 server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection has been made
- and may change once the client is authenticated.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The capabilities.</value>
- <exception cref="T:System.ArgumentException">
- Capabilities cannot be enabled, they may only be disabled.
- </exception>
- </member>
- <member name="P:MailKit.Net.Pop3.IPop3Client.ExpirePolicy">
- <summary>
- Gets the expiration policy.
- </summary>
- <remarks>
- <para>If the server supports the EXPIRE capability (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Expire"/>), the value
- of the <see cref="P:MailKit.Net.Pop3.IPop3Client.ExpirePolicy"/> property will reflect the value advertized by the server.</para>
- <para>A value of <c>-1</c> indicates that messages will never expire.</para>
- <para>A value of <c>0</c> indicates that messages that have been retrieved during the current session
- will be purged immediately after the connection is closed via the <c>QUIT</c> command.</para>
- <para>Values larger than <c>0</c> indicate the minimum number of days that the server will retain
- messages which have been retrieved.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The expiration policy.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.IPop3Client.Implementation">
- <summary>
- Gets the implementation details of the server.
- </summary>
- <remarks>
- If the server advertizes its implementation details, this value will be set to a string containing the
- information details provided by the server.
- </remarks>
- <value>The implementation details.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.IPop3Client.LoginDelay">
- <summary>
- Gets the minimum delay, in milliseconds, between logins.
- </summary>
- <remarks>
- If the server supports the LOGIN-DELAY capability (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.LoginDelay"/>), this value
- will be set to the minimum number of milliseconds that the client must wait between logins.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The login delay.</value>
- </member>
- <member name="M:MailKit.Net.Pop3.IPop3Client.EnableUTF8(System.Threading.CancellationToken)">
- <summary>
- Enable UTF8 mode.
- </summary>
- <remarks>
- The POP3 UTF8 extension allows the client to retrieve messages in the UTF-8 encoding and
- may also allow the user to authenticate using a UTF-8 encoded username or password.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has already been authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UTF8 extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.IPop3Client.EnableUTF8Async(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable UTF8 mode.
- </summary>
- <remarks>
- The POP3 UTF8 extension allows the client to retrieve messages in the UTF-8 encoding and
- may also allow the user to authenticate using a UTF-8 encoded username or password.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has already been authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UTF8 extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.IPop3Client.GetLanguages(System.Threading.CancellationToken)">
- <summary>
- Get the list of languages supported by the POP3 server.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- query the list of languages supported by the POP3 server that can
- be used for error messages.
- </remarks>
- <returns>The supported languages.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.IPop3Client.GetLanguagesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the list of languages supported by the POP3 server.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- query the list of languages supported by the POP3 server that can
- be used for error messages.
- </remarks>
- <returns>The supported languages.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.IPop3Client.SetLanguage(System.String,System.Threading.CancellationToken)">
- <summary>
- Set the language used by the POP3 server for error messages.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- set the language used by the POP3 server for error messages.
- </remarks>
- <param name="lang">The language code.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="lang"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="lang"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.IPop3Client.SetLanguageAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the language used by the POP3 server for error messages.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- set the language used by the POP3 server for error messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="lang">The language code.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="lang"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="lang"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3Capabilities">
- <summary>
- Capabilities supported by a POP3 server.
- </summary>
- <remarks>
- Capabilities are read as part of the response to the <c>CAPA</c> command that
- is issued during the connection and authentication phases of the
- <see cref="T:MailKit.Net.Pop3.Pop3Client"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.None">
- <summary>
- The server does not support any additional extensions.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Apop">
- <summary>
- The server supports <a href="https://tools.ietf.org/html/rfc1939#page-15">APOP</a>
- authentication.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Expire">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2449">EXPIRE</a> extension
- and defines the expiration policy for messages (see <see cref="P:MailKit.Net.Pop3.Pop3Client.ExpirePolicy"/>).
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.LoginDelay">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2449">LOGIN-DELAY</a> extension,
- allowing the server to specify to the client a minimum number of seconds between login attempts
- (see <see cref="P:MailKit.Net.Pop3.Pop3Client.LoginDelay"/>).
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2449">PIPELINING</a> extension,
- allowing the client to batch multiple requests to the server at at time.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.ResponseCodes">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2449">RESP-CODES</a> extension,
- allowing the server to provide clients with extended information in error responses.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Sasl">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2449">SASL</a> authentication
- extension, allowing the client to authenticate using the advertized authentication mechanisms
- (see <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/>).
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.StartTLS">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2595">STLS</a> extension,
- allowing clients to switch to an encrypted SSL/TLS connection after connecting.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Top">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc1939#page-11">TOP</a> command,
- allowing clients to fetch the headers plus an arbitrary number of lines.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc1939#page-12">UIDL</a> command,
- allowing the client to refer to messages via a UID as opposed to a sequence ID.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.User">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc1939#page-13">USER</a>
- authentication command, allowing the client to authenticate via a plain-text username
- and password command (not recommended unless no other authentication mechanisms exist).
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.UTF8">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6856">UTF8</a> extension,
- allowing clients to retrieve messages in the UTF-8 encoding.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.UTF8User">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6856">UTF8=USER</a> extension,
- allowing clients to authenticate using UTF-8 encoded usernames and passwords.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Lang">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6856">LANG</a> extension,
- allowing clients to specify which language the server should use for error strings.
- </summary>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3CommandHandler">
- <summary>
- POP3 command handler.
- </summary>
- <remarks>
- All exceptions thrown by the handler are considered fatal and will
- force-disconnect the connection. If a non-fatal error occurs, set
- it on the <see cref="P:MailKit.Net.Pop3.Pop3Command.Exception"/> property.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3CommandException">
- <summary>
- A POP3 command exception.
- </summary>
- <remarks>
- The exception that is thrown when a POP3 command fails. Unlike a <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/>,
- a <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> does not require the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> to be reconnected.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="ExceptionHandling"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> from the serialized data.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.String,System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="statusText">The response status text.</param>
- <param name="innerException">An inner exception.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="statusText"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="statusText">The response status text.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="statusText"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3CommandException.StatusText">
- <summary>
- Get the response status text.
- </summary>
- <remarks>
- Gets the response status text.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="ExceptionHandling"/>
- </example>
- <value>The response status text.</value>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3CommandException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
- with information about the exception.
- </summary>
- <remarks>
- Serializes the state of the <see cref="T:MailKit.FolderNotFoundException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3EngineState">
- <summary>
- The state of the <see cref="T:MailKit.Net.Pop3.Pop3Engine"/>.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3EngineState.Disconnected">
- <summary>
- The Pop3Engine is in the disconnected state.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3EngineState.Connected">
- <summary>
- The Pop3Engine is in the connected state.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3EngineState.Transaction">
- <summary>
- The Pop3Engine is in the transaction state, indicating that it is
- authenticated and may retrieve messages from the server.
- </summary>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3Engine">
- <summary>
- A POP3 command engine.
- </summary>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Engine"/> class.
- </summary>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.Uri">
- <summary>
- Gets the URI of the POP3 server.
- </summary>
- <remarks>
- Gets the URI of the POP3 server.
- </remarks>
- <value>The URI of the POP3 server.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.AuthenticationMechanisms">
- <summary>
- Gets the authentication mechanisms supported by the POP3 server.
- </summary>
- <remarks>
- The authentication mechanisms are queried durring the
- <see cref="M:MailKit.Net.Pop3.Pop3Engine.ConnectAsync(MailKit.Net.Pop3.Pop3Stream,System.Threading.CancellationToken)"/> method.
- </remarks>
- <value>The authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.Capabilities">
- <summary>
- Gets the capabilities supported by the POP3 server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection
- has been made via the <see cref="M:MailKit.Net.Pop3.Pop3Engine.ConnectAsync(MailKit.Net.Pop3.Pop3Stream,System.Threading.CancellationToken)"/> method.
- </remarks>
- <value>The capabilities.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.Stream">
- <summary>
- Gets the underlying POP3 stream.
- </summary>
- <remarks>
- Gets the underlying POP3 stream.
- </remarks>
- <value>The pop3 stream.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.State">
- <summary>
- Gets or sets the state of the engine.
- </summary>
- <remarks>
- Gets or sets the state of the engine.
- </remarks>
- <value>The engine state.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.IsConnected">
- <summary>
- Gets whether or not the engine is currently connected to a POP3 server.
- </summary>
- <remarks>
- Gets whether or not the engine is currently connected to a POP3 server.
- </remarks>
- <value><c>true</c> if the engine is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.ApopToken">
- <summary>
- Gets the APOP authentication token.
- </summary>
- <remarks>
- Gets the APOP authentication token.
- </remarks>
- <value>The APOP authentication token.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.ExpirePolicy">
- <summary>
- Gets the EXPIRE extension policy value.
- </summary>
- <remarks>
- Gets the EXPIRE extension policy value.
- </remarks>
- <value>The EXPIRE policy.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.Implementation">
- <summary>
- Gets the implementation details of the server.
- </summary>
- <remarks>
- Gets the implementation details of the server.
- </remarks>
- <value>The implementation details.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.LoginDelay">
- <summary>
- Gets the login delay.
- </summary>
- <remarks>
- Gets the login delay.
- </remarks>
- <value>The login delay.</value>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.Connect(MailKit.Net.Pop3.Pop3Stream,System.Threading.CancellationToken)">
- <summary>
- Takes posession of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and reads the greeting.
- </summary>
- <remarks>
- Takes posession of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and reads the greeting.
- </remarks>
- <param name="pop3">The pop3 stream.</param>
- <param name="cancellationToken">The cancellation token</param>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.ConnectAsync(MailKit.Net.Pop3.Pop3Stream,System.Threading.CancellationToken)">
- <summary>
- Takes posession of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and reads the greeting.
- </summary>
- <remarks>
- Takes posession of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and reads the greeting.
- </remarks>
- <param name="pop3">The pop3 stream.</param>
- <param name="cancellationToken">The cancellation token</param>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.Disconnect">
- <summary>
- Disconnects the <see cref="T:MailKit.Net.Pop3.Pop3Engine"/>.
- </summary>
- <remarks>
- Disconnects the <see cref="T:MailKit.Net.Pop3.Pop3Engine"/>.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.ReadLine(System.Threading.CancellationToken)">
- <summary>
- Reads a single line from the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/>.
- </summary>
- <returns>The line.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.InvalidOperationException">
- The engine is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.ReadLineAsync(System.Threading.CancellationToken)">
- <summary>
- Reads a single line from the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/>.
- </summary>
- <returns>The line.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.InvalidOperationException">
- The engine is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.Iterate">
- <summary>
- Iterate the command pipeline.
- </summary>
- <returns>The ID of the command that just completed.</returns>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.IterateAsync">
- <summary>
- Iterate the command pipeline.
- </summary>
- <returns>The ID of the command that just completed.</returns>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3Language">
- <summary>
- A POP3 language.
- </summary>
- <remarks>
- A POP3 language.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Language.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Language"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3Language"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Language.Language">
- <summary>
- Get the language code.
- </summary>
- <remarks>
- Gets the language code. This is the value that should be given to
- <see cref="M:MailKit.Net.Pop3.Pop3Client.SetLanguage(System.String,System.Threading.CancellationToken)"/>.
- </remarks>
- <value>The language.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Language.Description">
- <summary>
- Get the description.
- </summary>
- <remarks>
- Gets the description.
- </remarks>
- <value>The description.</value>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3ProtocolException">
- <summary>
- A POP3 protocol exception.
- </summary>
- <remarks>
- The exception that is thrown when there is an error communicating with a POP3 server. A
- <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> is typically fatal and requires the <see cref="T:MailKit.Net.Pop3.Pop3Client"/>
- to be reconnected.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="ExceptionHandling"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3ProtocolException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> from the serialized data.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3ProtocolException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3ProtocolException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3ProtocolException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3StreamMode">
- <summary>
- An enumeration of the possible POP3 streaming modes.
- </summary>
- <remarks>
- Normal operation is done in the <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/> mode,
- but when retrieving messages (via RETR) or headers (via TOP), the
- <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Data"/> mode should be used.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3StreamMode.Line">
- <summary>
- Reads 1 line at a time.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3StreamMode.Data">
- <summary>
- Reads data in chunks, ignoring line state.
- </summary>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3Stream">
- <summary>
- A stream for communicating with a POP3 server.
- </summary>
- <remarks>
- A stream capable of reading data line-by-line (<see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/>)
- or by raw byte streams (<see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Data"/>).
- </remarks>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.#ctor(System.IO.Stream,MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3Stream"/>.
- </remarks>
- <param name="source">The underlying network stream.</param>
- <param name="protocolLogger">The protocol logger.</param>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.Stream">
- <summary>
- Get or sets the underlying network stream.
- </summary>
- <remarks>
- Gets or sets the underlying network stream.
- </remarks>
- <value>The underlying network stream.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.Mode">
- <summary>
- Gets or sets the mode used for reading.
- </summary>
- <value>The mode.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.IsConnected">
- <summary>
- Get whether or not the stream is connected.
- </summary>
- <remarks>
- Gets whether or not the stream is connected.
- </remarks>
- <value><c>true</c> if the stream is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.IsEndOfData">
- <summary>
- Get whether or not the end of the raw data has been reached in <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Data"/> mode.
- </summary>
- <remarks>
- When reading the resonse to a command such as RETR, the end of the data is marked by line matching ".\r\n".
- </remarks>
- <value><c>true</c> if the end of the data has been reached; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.CanRead">
- <summary>
- Get whether the stream supports reading.
- </summary>
- <remarks>
- Gets whether the stream supports reading.
- </remarks>
- <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.CanWrite">
- <summary>
- Get whether the stream supports writing.
- </summary>
- <remarks>
- Gets whether the stream supports writing.
- </remarks>
- <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.CanSeek">
- <summary>
- Get whether the stream supports seeking.
- </summary>
- <remarks>
- Gets whether the stream supports seeking.
- </remarks>
- <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.CanTimeout">
- <summary>
- Get whether the stream supports I/O timeouts.
- </summary>
- <remarks>
- Gets whether the stream supports I/O timeouts.
- </remarks>
- <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.ReadTimeout">
- <summary>
- Get or set a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
- </summary>
- <remarks>
- Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
- </remarks>
- <returns>A value, in milliseconds, that determines how long the stream will attempt to read before timing out.</returns>
- <value>The read timeout.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.WriteTimeout">
- <summary>
- Get or set a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
- </summary>
- <remarks>
- Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
- </remarks>
- <returns>A value, in milliseconds, that determines how long the stream will attempt to write before timing out.</returns>
- <value>The write timeout.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.Position">
- <summary>
- Get or set the position within the current stream.
- </summary>
- <remarks>
- Gets or sets the position within the current stream.
- </remarks>
- <returns>The current position within the stream.</returns>
- <value>The position of the stream.</value>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.Length">
- <summary>
- Get the length of the stream, in bytes.
- </summary>
- <remarks>
- Gets the length of the stream, in bytes.
- </remarks>
- <returns>A long value representing the length of the stream in bytes.</returns>
- <value>The length of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Read(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The stream is in line mode (see <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/>).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The stream is in line mode (see <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/>).
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The stream is in line mode (see <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/>).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.ReadLine(System.IO.Stream,System.Threading.CancellationToken)">
- <summary>
- Reads a single line of input from the stream.
- </summary>
- <remarks>
- This method should be called in a loop until it returns <c>true</c>.
- </remarks>
- <returns><c>true</c>, if reading the line is complete, <c>false</c> otherwise.</returns>
- <param name="ostream">The output stream to write the line data into.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.ReadLineAsync(System.IO.Stream,System.Threading.CancellationToken)">
- <summary>
- Asynchronously reads a single line of input from the stream.
- </summary>
- <remarks>
- This method should be called in a loop until it returns <c>true</c>.
- </remarks>
- <returns><c>true</c>, if reading the line is complete, <c>false</c> otherwise.</returns>
- <param name="ostream">The output stream to write the line data into.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Write(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <returns>A task that represents the asynchronous write operation.</returns>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Flush(System.Threading.CancellationToken)">
- <summary>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Flush">
- <summary>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.FlushAsync(System.Threading.CancellationToken)">
- <summary>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <returns>A task that represents the asynchronous flush operation.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- Sets the position within the current stream.
- </summary>
- <returns>The new position within the stream.</returns>
- <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
- <param name="origin">The origin to seek from.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.SetLength(System.Int64)">
- <summary>
- Sets the length of the stream.
- </summary>
- <param name="value">The desired length of the stream in bytes.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support setting the length.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and
- optionally releases the managed resources.
- </summary>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Net.Proxy.HttpProxyClient">
- <summary>
- An HTTP proxy client.
- </summary>
- <remarkas>
- An HTTP proxy client.
- </remarkas>
- </member>
- <member name="M:MailKit.Net.Proxy.HttpProxyClient.#ctor(System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.HttpProxyClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.HttpProxyClient"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.HttpProxyClient.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.HttpProxyClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.HttpProxyClient"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="host"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.HttpProxyClient.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.HttpProxyClient.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Proxy.IProxyClient">
- <summary>
- An interface for connecting to services via a proxy.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Smtp.SmtpClient"/>
- and <see cref="T:MailKit.Net.Pop3.Pop3Client"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Proxy.IProxyClient.ProxyCredentials">
- <summary>
- Gets the proxy credentials.
- </summary>
- <remarks>
- Gets the credentials to use when authenticating with the proxy server.
- </remarks>
- <value>The proxy credentials.</value>
- </member>
- <member name="P:MailKit.Net.Proxy.IProxyClient.ProxyHost">
- <summary>
- Get the proxy host.
- </summary>
- <remarks>
- Gets the host name of the proxy server.
- </remarks>
- <value>The host name of the proxy server.</value>
- </member>
- <member name="P:MailKit.Net.Proxy.IProxyClient.ProxyPort">
- <summary>
- Get the proxy port.
- </summary>
- <remarks>
- Gets the port to use when connecting to the proxy server.
- </remarks>
- <value>The proxy port.</value>
- </member>
- <member name="P:MailKit.Net.Proxy.IProxyClient.LocalEndPoint">
- <summary>
- Get or set the local IP end point to use when connecting to a remote host.
- </summary>
- <remarks>
- Gets or sets the local IP end point to use when connecting to a remote host.
- </remarks>
- <value>The local IP end point or <c>null</c> to use the default end point.</value>
- </member>
- <member name="M:MailKit.Net.Proxy.IProxyClient.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.IProxyClient.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.IProxyClient.Connect(System.String,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="timeout">The timeout, in milliseconds.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.TimeoutException">
- The operation timed out.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.IProxyClient.ConnectAsync(System.String,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="timeout">The timeout, in milliseconds.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.TimeoutException">
- The operation timed out.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Proxy.ProxyClient">
- <summary>
- An abstract proxy client base class.
- </summary>
- <remarks>
- A proxy client can be used to connect to a service through a firewall that
- would otherwise be blocked.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyClient.#ctor(System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyClient"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyClient.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyClient"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="host"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="P:MailKit.Net.Proxy.ProxyClient.ProxyCredentials">
- <summary>
- Gets the proxy credentials.
- </summary>
- <remarks>
- Gets the credentials to use when authenticating with the proxy server.
- </remarks>
- <value>The proxy credentials.</value>
- </member>
- <member name="P:MailKit.Net.Proxy.ProxyClient.ProxyHost">
- <summary>
- Get the proxy host.
- </summary>
- <remarks>
- Gets the host name of the proxy server.
- </remarks>
- <value>The host name of the proxy server.</value>
- </member>
- <member name="P:MailKit.Net.Proxy.ProxyClient.ProxyPort">
- <summary>
- Get the proxy port.
- </summary>
- <remarks>
- Gets the port to use when connecting to the proxy server.
- </remarks>
- <value>The proxy port.</value>
- </member>
- <member name="P:MailKit.Net.Proxy.ProxyClient.LocalEndPoint">
- <summary>
- Get or set the local IP end point to use when connecting to a remote host.
- </summary>
- <remarks>
- Gets or sets the local IP end point to use when connecting to a remote host.
- </remarks>
- <value>The local IP end point or <c>null</c> to use the default end point.</value>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyClient.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyClient.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyClient.Connect(System.String,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="timeout">The timeout, in milliseconds.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="port"/> is not between <c>1</c> and <c>65535</c>.</para>
- <para>-or-</para>
- <para><paramref name="timeout"/> is less than <c>-1</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.TimeoutException">
- The operation timed out.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyClient.ConnectAsync(System.String,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="timeout">The timeout, in milliseconds.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="port"/> is not between <c>1</c> and <c>65535</c>.</para>
- <para>-or-</para>
- <para><paramref name="timeout"/> is less than <c>-1</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.TimeoutException">
- The operation timed out.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Proxy.ProxyProtocolException">
- <summary>
- A proxy protocol exception.
- </summary>
- <remarks>
- The exception that is thrown when there is an error communicating with a proxy server.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyProtocolException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/> from the serialized data.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyProtocolException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyProtocolException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyProtocolException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Proxy.Socks4aClient">
- <summary>
- A SOCKS4a proxy client.
- </summary>
- <remarkas>
- A SOCKS4a proxy client.
- </remarkas>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks4aClient.#ctor(System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4aClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4aClient"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks4aClient.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="host"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- </member>
- <member name="T:MailKit.Net.Proxy.Socks4Client">
- <summary>
- A SOCKS4 proxy client.
- </summary>
- <remarkas>
- A SOCKS4 proxy client.
- </remarkas>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks4Client.#ctor(System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks4Client.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="host"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- </member>
- <member name="P:MailKit.Net.Proxy.Socks4Client.IsSocks4a">
- <summary>
- Get or set whether this <see cref="T:MailKit.Net.Proxy.Socks4Client"/> is a Socks4a client.
- </summary>
- <remarks>
- Gets or sets whether this <see cref="T:MailKit.Net.Proxy.Socks4Client"/> is a Socks4a client.
- </remarks>
- <value><c>true</c> if is is a Socks4a client; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks4Client.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks4Client.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Proxy.Socks5Client">
- <summary>
- A SOCKS5 proxy client.
- </summary>
- <remarkas>
- A SOCKS5 proxy client.
- </remarkas>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks5Client.#ctor(System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks5Client"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks5Client"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks5Client.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks5Client"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks5Client"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="host"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks5Client.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks5Client.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Proxy.SocksClient">
- <summary>
- An abstract SOCKS proxy client.
- </summary>
- <remarks>
- An abstract SOCKS proxy client.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Proxy.SocksClient.#ctor(System.Int32,System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.SocksClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.SocksClient"/> class.
- </remarks>
- <param name="version">The SOCKS protocol version.</param>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.SocksClient.#ctor(System.Int32,System.String,System.Int32,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.SocksClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.SocksClient"/> class.
- </remarks>
- <param name="version">The SOCKS protocol version.</param>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="host"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- </member>
- <member name="P:MailKit.Net.Proxy.SocksClient.SocksVersion">
- <summary>
- Get the SOCKS protocol version.
- </summary>
- <remarks>
- Gets the SOCKS protocol version.
- </remarks>
- <value>The SOCKS protocol version.</value>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpClient">
- <summary>
- An SMTP client that can be used to send email messages.
- </summary>
- <remarks>
- <para>The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> class supports both the "smtp" and "smtps" protocols. The "smtp"
- protocol makes a clear-text connection to the SMTP server and does not use SSL or TLS unless the SMTP
- server supports the <a href="https://tools.ietf.org/html/rfc3207">STARTTLS</a> extension. The "smtps"
- protocol, however, connects to the SMTP server using an SSL-wrapped connection.</para>
- <para>The connection established by any of the
- <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a> methods may be re-used if an
- application wishes to send multiple messages to the same SMTP server. Since connecting and authenticating
- can be expensive operations, re-using a connection can significantly improve performance when sending a
- large number of messages to the same SMTP server over a short period of time.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessages" />
- </example>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.SendCommandAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously send a custom command to the SMTP server.
- </summary>
- <remarks>
- <para>Asynchronously sends a custom command to the SMTP server.</para>
- <note type="note">The command string should not include the terminating <c>\r\n</c> sequence.</note>
- </remarks>
- <returns>The command response.</returns>
- <param name="command">The command.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="command"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The SMTP server does not support authentication.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the SMTP server supports authentication, then the SASL mechanisms
- that both the client and server support are tried in order of greatest
- security to weakest security. Once a SASL authentication mechanism is
- found that both client and server support, the credentials are used to
- authenticate.</para>
- <para>If, on the other hand, authentication is not supported by the SMTP
- server, then this method will throw <see cref="T:System.NotSupportedException"/>.
- The <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> property can be checked for the
- <see cref="F:MailKit.Net.Smtp.SmtpCapabilities.Authentication"/> flag to make sure the
- SMTP server supports authentication before calling this method.</para>
- <note type="tip"> To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The text encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The SMTP server does not support authentication.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified SMTP or SMTP/S server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified SMTP or SMTP/S server.</para>
- <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
- <paramref name="options"/> parameter is used to determine the default port to
- connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
- is <c>465</c>. All other values will use a default port of <c>25</c>.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>465</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
- populated.</para>
- <note type="note">The connection established by any of the
- <a href="Overload_MailKit_Net_Smtp_SmtpClient_ConnectAsync.htm">Connect</a>
- methods may be re-used if an application wishes to send multiple messages
- to the same SMTP server. Since connecting and authenticating can be expensive
- operations, re-using a connection can significantly improve performance when
- sending a large number of messages to the same SMTP server over a short
- period of time.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the SMTP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- An SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified SMTP or SMTP/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified SMTP or SMTP/S server using the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>465</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the SMTP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- An SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified SMTP or SMTP/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified SMTP or SMTP/S server using the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>465</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the SMTP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- An SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="quit">If set to <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.NoOpAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously ping the SMTP server to keep the connection alive.
- </summary>
- <remarks>Mail servers, if left idle for too long, will automatically drop the connection.</remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message.
- </summary>
- <remarks>
- <para>Sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessageWithOptions"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Sends the message by uploading it to an SMTP server using the supplied sender and recipients.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="sender"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="recipients"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.ExpandAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously expand a mailing address alias.
- </summary>
- <remarks>
- Expands a mailing address alias.
- </remarks>
- <returns>The expanded list of mailbox addresses.</returns>
- <param name="alias">The mailing address alias.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="alias"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="alias"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.VerifyAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously verify the existence of a mailbox address.
- </summary>
- <remarks>
- Verifies the existence a mailbox address with the SMTP server, returning the expanded
- mailbox address if it exists.
- </remarks>
- <returns>The expanded mailbox address.</returns>
- <param name="address">The mailbox address.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="address"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> class.
- </summary>
- <remarks>
- Before you can send messages with the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>, you must first call one of
- the <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a> methods.
- Depending on whether the SMTP server requires authenticating or not, you may also need to
- authenticate using one of the
- <a href="Overload_MailKit_Net_Smtp_SmtpClient_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessages" />
- </example>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> class.
- </summary>
- <remarks>
- Before you can send messages with the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>, you must first call one of
- the <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a> methods.
- Depending on whether the SMTP server requires authenticating or not, you may also need to
- authenticate using one of the
- <a href="Overload_MailKit_Net_Smtp_SmtpClient_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ProtocolLogger"/>
- </example>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.Stream">
- <summary>
- Get the underlying SMTP stream.
- </summary>
- <remarks>
- Gets the underlying SMTP stream.
- </remarks>
- <value>The SMTP stream.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the SMTP server.
- </summary>
- <remarks>
- <para>Gets an object that can be used to synchronize access to the SMTP server between multiple threads.</para>
- <para>When using <see cref="T:MailKit.Net.Smtp.SmtpClient"/> methods from multiple threads, it is important to lock the
- <see cref="P:MailKit.Net.Smtp.SmtpClient.SyncRoot"/> object for thread safety.</para>
- </remarks>
- <value>The lock object.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.Protocol">
- <summary>
- Get the protocol supported by the message service.
- </summary>
- <remarks>
- Gets the protocol supported by the message service.
- </remarks>
- <value>The protocol.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.Capabilities">
- <summary>
- Get the capabilities supported by the SMTP server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection has been made
- and may change once the client is authenticated.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
- </example>
- <value>The capabilities.</value>
- <exception cref="T:System.ArgumentException">
- Capabilities cannot be enabled, they may only be disabled.
- </exception>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.LocalDomain">
- <summary>
- Get or set the local domain.
- </summary>
- <remarks>
- The local domain is used in the HELO or EHLO commands sent to
- the SMTP server. If left unset, the local IP address will be
- used instead.
- </remarks>
- <value>The local domain.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.PreferSendAsBinaryData">
- <summary>
- Get whether or not the BDAT command is preferred over the DATA command.
- </summary>
- <remarks>
- <para>Gets whether or not the <c>BDAT</c> command is preferred over the standard <c>DATA</c>
- command.</para>
- <para>The <c>BDAT</c> command is normally only used when the message being sent contains binary data
- (e.g. one mor more MIME parts contains a <c>Content-Transfer-Encoding: binary</c> header). This
- option provides a way to override this behavior, forcing the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> to send
- messages using the <c>BDAT</c> command instead of the <c>DATA</c> command even when it is not
- necessary to do so.</para>
- </remarks>
- <value><c>true</c> if the <c>BDAT</c> command is preferred over the <c>DATA</c> command; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.MaxSize">
- <summary>
- Get the maximum message size supported by the server.
- </summary>
- <remarks>
- <para>The maximum message size will not be known until a successful connection has
- been made and may change once the client is authenticated.</para>
- <note type="note">This value is only relevant if the <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> includes
- the <see cref="F:MailKit.Net.Smtp.SmtpCapabilities.Size"/> flag.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
- </example>
- <value>The maximum message size supported by the server.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms">
- <summary>
- Get the authentication mechanisms supported by the SMTP server.
- </summary>
- <remarks>
- <para>The authentication mechanisms are queried as part of the connection
- process.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> hash set
- before authenticating.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
- </example>
- <value>The authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.Timeout">
- <summary>
- Get or set the timeout for network streaming operations, in milliseconds.
- </summary>
- <remarks>
- Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
- and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
- </remarks>
- <value>The timeout in milliseconds.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.IsConnected">
- <summary>
- Get whether or not the client is currently connected to an SMTP server.
- </summary>
- <remarks>
- <para>The <see cref="P:MailKit.Net.Smtp.SmtpClient.IsConnected"/> state is set to <c>true</c> immediately after
- one of the <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a>
- methods succeeds and is not set back to <c>false</c> until either the client
- is disconnected via <see cref="M:MailKit.Net.Smtp.SmtpClient.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until an
- <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> is thrown while attempting to read or write to
- the underlying network socket.</para>
- <para>When an <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> is caught, the connection state of the
- <see cref="T:MailKit.Net.Smtp.SmtpClient"/> should be checked before continuing.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.IsSecure">
- <summary>
- Get whether or not the connection is secure (typically via SSL or TLS).
- </summary>
- <remarks>
- Gets whether or not the connection is secure (typically via SSL or TLS).
- </remarks>
- <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.IsAuthenticated">
- <summary>
- Get whether or not the client is currently authenticated with the SMTP server.
- </summary>
- <remarks>
- <para>Gets whether or not the client is currently authenticated with the SMTP server.</para>
- <para>To authenticate with the SMTP server, use one of the
- <a href="Overload_MailKit_Net_Smtp_SmtpClient_Authenticate.htm">Authenticate</a>
- methods.</para>
- </remarks>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.OnNoRecipientsAccepted(MimeKit.MimeMessage)">
- <summary>
- Invoked only when no recipients were accepted by the SMTP server.
- </summary>
- <remarks>
- If <see cref="M:MailKit.Net.Smtp.SmtpClient.OnRecipientNotAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)"/> is overridden to not throw
- an exception, this method should be overridden to throw an appropriate
- exception instead.
- </remarks>
- <param name="message">The message being sent.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.SendCommand(System.String,System.Threading.CancellationToken)">
- <summary>
- Send a custom command to the SMTP server.
- </summary>
- <remarks>
- <para>Sends a custom command to the SMTP server.</para>
- <note type="note">The command string should not include the terminating <c>\r\n</c> sequence.</note>
- </remarks>
- <returns>The command response.</returns>
- <param name="command">The command.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="command"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The SMTP server does not support authentication.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the SMTP server supports authentication, then the SASL mechanisms
- that both the client and server support are tried in order of greatest
- security to weakest security. Once a SASL authentication mechanism is
- found that both client and server support, the credentials are used to
- authenticate.</para>
- <para>If, on the other hand, authentication is not supported by the SMTP
- server, then this method will throw <see cref="T:System.NotSupportedException"/>.
- The <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> property can be checked for the
- <see cref="F:MailKit.Net.Smtp.SmtpCapabilities.Authentication"/> flag to make sure the
- SMTP server supports authentication before calling this method.</para>
- <note type="tip"> To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <param name="encoding">The text encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The SMTP server does not support authentication.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified SMTP or SMTP/S server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified SMTP or SMTP/S server.</para>
- <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
- <paramref name="options"/> parameter is used to determine the default port to
- connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
- is <c>465</c>. All other values will use a default port of <c>25</c>.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>465</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
- populated.</para>
- <note type="note">The connection established by any of the
- <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a>
- methods may be re-used if an application wishes to send multiple messages
- to the same SMTP server. Since connecting and authenticating can be expensive
- operations, re-using a connection can significantly improve performance when
- sending a large number of messages to the same SMTP server over a short
- period of time.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the SMTP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- An SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified SMTP or SMTP/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified SMTP or SMTP/S server using the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>465</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the SMTP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- An SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified SMTP or SMTP/S server using the provided stream.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified SMTP or SMTP/S server using the provided stream.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>465</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the SMTP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- An SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Disconnect(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="quit">If set to <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.NoOp(System.Threading.CancellationToken)">
- <summary>
- Ping the SMTP server to keep the connection alive.
- </summary>
- <remarks>Mail servers, if left idle for too long, will automatically drop the connection.</remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.OnSenderAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)">
- <summary>
- Invoked when the sender is accepted by the SMTP server.
- </summary>
- <remarks>
- The default implementation does nothing.
- </remarks>
- <param name="message">The message being sent.</param>
- <param name="mailbox">The mailbox used in the <c>MAIL FROM</c> command.</param>
- <param name="response">The response to the <c>MAIL FROM</c> command.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.OnSenderNotAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)">
- <summary>
- Invoked when a recipient is not accepted by the SMTP server.
- </summary>
- <remarks>
- The default implementation throws an appropriate <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <param name="message">The message being sent.</param>
- <param name="mailbox">The mailbox used in the <c>MAIL FROM</c> command.</param>
- <param name="response">The response to the <c>MAIL FROM</c> command.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.GetEnvelopeId(MimeKit.MimeMessage)">
- <summary>
- Get the envelope identifier to be used with delivery status notifications.
- </summary>
- <remarks>
- <para>The envelope identifier, if non-empty, is useful in determining which message a delivery
- status notification was issued for.</para>
- <para>The envelope identifier should be unique and may be up to 100 characters in length, but
- must consist only of printable ASCII characters and no white space.</para>
- <para>For more information, see
- <a href="https://tools.ietf.org/html/rfc3461#section-4.4">rfc3461, section 4.4</a>.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="DeliveryStatusNotification"/>
- </example>
- <returns>The envelope identifier.</returns>
- <param name="message">The message.</param>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.DeliveryStatusNotificationType">
- <summary>
- Get or set how much of the message to include in any failed delivery status notifications.
- </summary>
- <remarks>
- Gets or sets how much of the message to include in any failed delivery status notifications.
- </remarks>
- <value>A value indicating how much of the message to include in a failure delivery status notification.</value>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.OnRecipientAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)">
- <summary>
- Invoked when a recipient is accepted by the SMTP server.
- </summary>
- <remarks>
- The default implementation does nothing.
- </remarks>
- <param name="message">The message being sent.</param>
- <param name="mailbox">The mailbox used in the <c>RCPT TO</c> command.</param>
- <param name="response">The response to the <c>RCPT TO</c> command.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.OnRecipientNotAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)">
- <summary>
- Invoked when a recipient is not accepted by the SMTP server.
- </summary>
- <remarks>
- The default implementation throws an appropriate <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <param name="message">The message being sent.</param>
- <param name="mailbox">The mailbox used in the <c>RCPT TO</c> command.</param>
- <param name="response">The response to the <c>RCPT TO</c> command.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.GetDeliveryStatusNotifications(MimeKit.MimeMessage,MimeKit.MailboxAddress)">
- <summary>
- Get the types of delivery status notification desired for the specified recipient mailbox.
- </summary>
- <remarks>
- Gets the types of delivery status notification desired for the specified recipient mailbox.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="DeliveryStatusNotification"/>
- </example>
- <returns>The desired delivery status notification type.</returns>
- <param name="message">The message being sent.</param>
- <param name="mailbox">The mailbox.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Prepare(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.EncodingConstraint,System.Int32)">
- <summary>
- Prepare the message for transport with the specified constraints.
- </summary>
- <remarks>
- <para>Prepares the message for transport with the specified constraints.</para>
- <para>Typically, this involves calling <see cref="M:MimeKit.MimeMessage.Prepare(MimeKit.EncodingConstraint,System.Int32)"/> on
- the message with the provided constraints.</para>
- </remarks>
- <param name="options">The format options.</param>
- <param name="message">The message.</param>
- <param name="constraint">The encoding constraint.</param>
- <param name="maxLineLength">The max line length supported by the server.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.GetSize(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken)">
- <summary>
- Get the size of the message.
- </summary>
- <remarks>
- <para>Calculates the size of the message in bytes.</para>
- <para>This method is called by <a href="Overload_MailKit_MailTransport_Send.htm">Send</a>
- methods in the following conditions:</para>
- <list type="bullet">
- <item>The SMTP server supports the <c>SIZE=</c> parameter in the <c>MAIL FROM</c> command.</item>
- <item>The <see cref="T:MailKit.ITransferProgress"/> parameter is non-null.</item>
- <item>The SMTP server supports the <c>CHUNKING</c> extension.</item>
- </list>
- </remarks>
- <returns>The size of the message, in bytes.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.GetSizeAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the size of the message.
- </summary>
- <remarks>
- <para>Asynchronously calculates the size of the message in bytes.</para>
- <para>This method is called by <a href="Overload_MailKit_MailTransport_SendAsync.htm">SendAsync</a>
- methods in the following conditions:</para>
- <list type="bullet">
- <item>The SMTP server supports the <c>SIZE=</c> parameter in the <c>MAIL FROM</c> command.</item>
- <item>The <see cref="T:MailKit.ITransferProgress"/> parameter is non-null.</item>
- <item>The SMTP server supports the <c>CHUNKING</c> extension.</item>
- </list>
- </remarks>
- <returns>The size of the message, in bytes.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message.
- </summary>
- <remarks>
- <para>Sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessageWithOptions"/>
- </example>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Sends the message by uploading it to an SMTP server using the supplied sender and recipients.
- </remarks>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="sender"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="recipients"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Expand(System.String,System.Threading.CancellationToken)">
- <summary>
- Expand a mailing address alias.
- </summary>
- <remarks>
- Expands a mailing address alias.
- </remarks>
- <returns>The expanded list of mailbox addresses.</returns>
- <param name="alias">The mailing address alias.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="alias"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="alias"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Verify(System.String,System.Threading.CancellationToken)">
- <summary>
- Verify the existence of a mailbox address.
- </summary>
- <remarks>
- Verifies the existence a mailbox address with the SMTP server, returning the expanded
- mailbox address if it exists.
- </remarks>
- <returns>The expanded mailbox address.</returns>
- <param name="address">The mailbox address.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="address"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Net.Smtp.ISmtpClient">
- <summary>
- An interface for an SMTP client.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Smtp.SmtpClient"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Smtp.ISmtpClient.Capabilities">
- <summary>
- Get the capabilities supported by the SMTP server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection has been made
- and may change once the client is authenticated.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
- </example>
- <value>The capabilities.</value>
- <exception cref="T:System.ArgumentException">
- Capabilities cannot be enabled, they may only be disabled.
- </exception>
- </member>
- <member name="P:MailKit.Net.Smtp.ISmtpClient.LocalDomain">
- <summary>
- Get or set the local domain.
- </summary>
- <remarks>
- The local domain is used in the HELO or EHLO commands sent to
- the SMTP server. If left unset, the local IP address will be
- used instead.
- </remarks>
- <value>The local domain.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.ISmtpClient.MaxSize">
- <summary>
- Get the maximum message size supported by the server.
- </summary>
- <remarks>
- <para>The maximum message size will not be known until a successful connection has
- been made and may change once the client is authenticated.</para>
- <note type="note">This value is only relevant if the <see cref="P:MailKit.Net.Smtp.ISmtpClient.Capabilities"/> includes
- the <see cref="F:MailKit.Net.Smtp.SmtpCapabilities.Size"/> flag.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
- </example>
- <value>The maximum message size supported by the server.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.ISmtpClient.DeliveryStatusNotificationType">
- <summary>
- Get or set how much of the message to include in any failed delivery status notifications.
- </summary>
- <remarks>
- Gets or sets how much of the message to include in any failed delivery status notifications.
- </remarks>
- <value>A value indicating how much of the message to include in a failure delivery status notification.</value>
- </member>
- <member name="M:MailKit.Net.Smtp.ISmtpClient.Expand(System.String,System.Threading.CancellationToken)">
- <summary>
- Expand a mailing address alias.
- </summary>
- <remarks>
- Expands a mailing address alias.
- </remarks>
- <returns>The expanded list of mailbox addresses.</returns>
- <param name="alias">The mailing address alias.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="alias"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="alias"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.ISmtpClient.ExpandAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously expand a mailing address alias.
- </summary>
- <remarks>
- Expands a mailing address alias.
- </remarks>
- <returns>The expanded list of mailbox addresses.</returns>
- <param name="alias">The mailing address alias.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="alias"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="alias"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.ISmtpClient.Verify(System.String,System.Threading.CancellationToken)">
- <summary>
- Verify the existence of a mailbox address.
- </summary>
- <remarks>
- Verifies the existence a mailbox address with the SMTP server, returning the expanded
- mailbox address if it exists.
- </remarks>
- <returns>The expanded mailbox address.</returns>
- <param name="address">The mailbox address.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="address"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.ISmtpClient.VerifyAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously verify the existence of a mailbox address.
- </summary>
- <remarks>
- Verifies the existence a mailbox address with the SMTP server, returning the expanded
- mailbox address if it exists.
- </remarks>
- <returns>The expanded mailbox address.</returns>
- <param name="address">The mailbox address.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="address"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpCapabilities">
- <summary>
- Capabilities supported by an SMTP server.
- </summary>
- <remarks>
- Capabilities are read as part of the response to the EHLO command that
- is issued during the connection phase of the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.None">
- <summary>
- The server does not support any additional extensions.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Size">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc1870">SIZE</a> extension
- and may have a maximum message size limitation (see <see cref="P:MailKit.Net.Smtp.SmtpClient.MaxSize"/>).
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Dsn">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc1891">DSN</a> extension,
- allowing clients to specify which (if any) recipients they would like to receive delivery
- notifications for.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.EnhancedStatusCodes">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2034">ENHANCEDSTATUSCODES</a>
- extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Authentication">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2554">AUTH</a> extension,
- allowing clients to authenticate via supported SASL mechanisms.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.EightBitMime">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2821">8BITMIME</a> extension,
- allowing clients to send messages using the "8bit" Content-Transfer-Encoding.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Pipelining">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2920">PIPELINING</a> extension,
- allowing clients to send multiple commands at once in order to reduce round-trip latency.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.BinaryMime">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3030">BINARYMIME</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Chunking">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3030">CHUNKING</a> extension,
- allowing clients to upload messages in chunks.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.StartTLS">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3207">STARTTLS</a> extension,
- allowing clients to switch to an encrypted SSL/TLS connection after connecting.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.UTF8">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6531">SMTPUTF8</a> extension.
- </summary>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpErrorCode">
- <summary>
- An enumeration of the possible error codes that may be reported by a <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </summary>
- <remarks>
- An enumeration of the possible error codes that may be reported by a <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpErrorCode.MessageNotAccepted">
- <summary>
- The message was not accepted for delivery. This may happen if
- the server runs out of available disk space.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpErrorCode.SenderNotAccepted">
- <summary>
- The sender's mailbox address was not accepted. Check the
- <see cref="P:MailKit.Net.Smtp.SmtpCommandException.Mailbox"/> property for the
- mailbox used as the sender's mailbox address.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpErrorCode.RecipientNotAccepted">
- <summary>
- A recipient's mailbox address was not accepted. Check the
- <see cref="P:MailKit.Net.Smtp.SmtpCommandException.Mailbox"/> property for the
- particular recipient mailbox that was not acccepted.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpErrorCode.UnexpectedStatusCode">
- <summary>
- An unexpected status code was returned by the server.
- For more details, the <see cref="P:System.Exception.Message"/>
- property may provide some additional hints.
- </summary>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpCommandException">
- <summary>
- An SMTP protocol exception.
- </summary>
- <remarks>
- The exception that is thrown when an SMTP command fails. Unlike a <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/>,
- a <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> does not require the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> to be reconnected.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> from the serialized data.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(MailKit.Net.Smtp.SmtpErrorCode,MailKit.Net.Smtp.SmtpStatusCode,MimeKit.MailboxAddress,System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <param name="code">The error code.</param>
- <param name="status">The status code.</param>
- <param name="mailbox">The rejected mailbox.</param>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(MailKit.Net.Smtp.SmtpErrorCode,MailKit.Net.Smtp.SmtpStatusCode,MimeKit.MailboxAddress,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <param name="code">The error code.</param>
- <param name="status">The status code.</param>
- <param name="mailbox">The rejected mailbox.</param>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(MailKit.Net.Smtp.SmtpErrorCode,MailKit.Net.Smtp.SmtpStatusCode,System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <param name="code">The error code.</param>
- <param name="status">The status code.</param>>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(MailKit.Net.Smtp.SmtpErrorCode,MailKit.Net.Smtp.SmtpStatusCode,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <param name="code">The error code.</param>
- <param name="status">The status code.</param>>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpCommandException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
- with information about the exception.
- </summary>
- <remarks>
- Serializes the state of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpCommandException.ErrorCode">
- <summary>
- Gets the error code which may provide additional information.
- </summary>
- <remarks>
- The error code can be used to programatically deal with the
- exception without necessarily needing to display the raw
- exception message to the user.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- <value>The status code.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpCommandException.Mailbox">
- <summary>
- Gets the mailbox that the error occurred on.
- </summary>
- <remarks>
- This property will only be available when the <see cref="P:MailKit.Net.Smtp.SmtpCommandException.ErrorCode"/>
- value is either <see cref="F:MailKit.Net.Smtp.SmtpErrorCode.SenderNotAccepted"/> or
- <see cref="F:MailKit.Net.Smtp.SmtpErrorCode.RecipientNotAccepted"/> and may be used
- to help the user decide how to proceed.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- <value>The mailbox.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpCommandException.StatusCode">
- <summary>
- Gets the status code returned by the SMTP server.
- </summary>
- <remarks>
- The raw SMTP status code that resulted in the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>
- being thrown.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- <value>The status code.</value>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpDataFilter">
- <summary>
- An SMTP filter designed to format a message stream for the DATA command.
- </summary>
- <remarks>
- A special stream filter that escapes lines beginning with a '.' as needed when
- sending a message via the SMTP protocol or when saving a message to an IIS
- message pickup directory.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SaveToPickupDirectory" />
- </example>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpDataFilter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpDataFilter"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpDataFilter"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SaveToPickupDirectory" />
- </example>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpDataFilter.Filter(System.Byte[],System.Int32,System.Int32,System.Int32@,System.Int32@,System.Boolean)">
- <summary>
- Filter the specified input.
- </summary>
- <remarks>
- Filters the specified input buffer starting at the given index,
- spanning across the specified number of bytes.
- </remarks>
- <returns>The filtered output.</returns>
- <param name="input">The input buffer.</param>
- <param name="startIndex">The starting index of the input buffer.</param>
- <param name="length">The length of the input buffer, starting at <paramref name="startIndex"/>.</param>
- <param name="outputIndex">The output index.</param>
- <param name="outputLength">The output length.</param>
- <param name="flush">If set to <c>true</c>, all internally buffered data should be flushed to the output buffer.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpDataFilter.Reset">
- <summary>
- Reset the filter.
- </summary>
- <remarks>
- Resets the filter.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpProtocolException">
- <summary>
- An SMTP protocol exception.
- </summary>
- <remarks>
- The exception that is thrown when there is an error communicating with an SMTP server. An
- <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> is typically fatal and requires the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>
- to be reconnected.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpProtocolException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> from the serialized data.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpProtocolException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpProtocolException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpProtocolException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpResponse">
- <summary>
- An SMTP command response.
- </summary>
- <remarks>
- An SMTP command response.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpResponse.StatusCode">
- <summary>
- Get the status code.
- </summary>
- <remarks>
- Gets the status code.
- </remarks>
- <value>The status code.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpResponse.Response">
- <summary>
- Get the response text.
- </summary>
- <remarks>
- Gets the response text.
- </remarks>
- <value>The response text.</value>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpResponse.#ctor(MailKit.Net.Smtp.SmtpStatusCode,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpResponse"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpResponse"/>.
- </remarks>
- <param name="code">The status code.</param>
- <param name="response">The response text.</param>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpStatusCode">
- <summary>
- An enumeration of possible SMTP status codes.
- </summary>
- <remarks>
- An enumeration of possible SMTP status codes.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.SystemStatus">
- <summary>
- The "system status" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.HelpMessage">
- <summary>
- The "help" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ServiceReady">
- <summary>
- The "service ready" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ServiceClosingTransmissionChannel">
- <summary>
- The "service closing transmission channel" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationSuccessful">
- <summary>
- The "authentication successful" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.Ok">
- <summary>
- The general purpose "OK" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.UserNotLocalWillForward">
- <summary>
- The "User not local; will forward" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.CannotVerifyUserWillAttemptDelivery">
- <summary>
- The "cannot verify user; will attempt delivery" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationChallenge">
- <summary>
- The "authentication challenge" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.StartMailInput">
- <summary>
- The "start mail input" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ServiceNotAvailable">
- <summary>
- The "service not available" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.PasswordTransitionNeeded">
- <summary>
- The "password transition needed" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.MailboxBusy">
- <summary>
- The "mailbox busy" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ErrorInProcessing">
- <summary>
- The "error in processing" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.InsufficientStorage">
- <summary>
- The "insufficient storage" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.TemporaryAuthenticationFailure">
- <summary>
- The "temporary authentication failure" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.CommandUnrecognized">
- <summary>
- The "command unrecognized" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.SyntaxError">
- <summary>
- The "syntax error" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.CommandNotImplemented">
- <summary>
- The "command not implemented" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.BadCommandSequence">
- <summary>
- The "bad command sequence" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.CommandParameterNotImplemented">
- <summary>
- The "command parameter not implemented" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationRequired">
- <summary>
- The "authentication required" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationMechanismTooWeak">
- <summary>
- The "authentication mechanism too weak" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationInvalidCredentials">
- <summary>
- The "authentication invalid credentials" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.EncryptionRequiredForAuthenticationMechanism">
- <summary>
- The "encryption required for authentication mechanism" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.MailboxUnavailable">
- <summary>
- The "mailbox unavailable" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.UserNotLocalTryAlternatePath">
- <summary>
- The "user not local try alternate path" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ExceededStorageAllocation">
- <summary>
- The "exceeded storage allocation" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.MailboxNameNotAllowed">
- <summary>
- The "mailbox name not allowed" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.TransactionFailed">
- <summary>
- The "transaction failed" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.MailFromOrRcptToParametersNotRecognizedOrNotImplemented">
- <summary>
- The "mail from/rcpt to parameters not recognized or not implemented" status code.
- </summary>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpStream">
- <summary>
- A stream for communicating with an SMTP server.
- </summary>
- <remarks>
- A stream capable of reading SMTP server responses.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.#ctor(System.IO.Stream,MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpStream"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpStream"/>.
- </remarks>
- <param name="source">The underlying network stream.</param>
- <param name="protocolLogger">The protocol logger.</param>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.Stream">
- <summary>
- Get or sets the underlying network stream.
- </summary>
- <remarks>
- Gets or sets the underlying network stream.
- </remarks>
- <value>The underlying network stream.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.IsConnected">
- <summary>
- Get whether or not the stream is connected.
- </summary>
- <remarks>
- Gets whether or not the stream is connected.
- </remarks>
- <value><c>true</c> if the stream is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.CanRead">
- <summary>
- Get whether the stream supports reading.
- </summary>
- <remarks>
- Gets whether the stream supports reading.
- </remarks>
- <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.CanWrite">
- <summary>
- Get whether the stream supports writing.
- </summary>
- <remarks>
- Gets whether the stream supports writing.
- </remarks>
- <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.CanSeek">
- <summary>
- Get whether the stream supports seeking.
- </summary>
- <remarks>
- Gets whether the stream supports seeking.
- </remarks>
- <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.CanTimeout">
- <summary>
- Get whether the stream supports I/O timeouts.
- </summary>
- <remarks>
- Gets whether the stream supports I/O timeouts.
- </remarks>
- <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.ReadTimeout">
- <summary>
- Get or set a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
- </summary>
- <remarks>
- Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
- </remarks>
- <returns>A value, in milliseconds, that determines how long the stream will attempt to read before timing out.</returns>
- <value>The read timeout.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.WriteTimeout">
- <summary>
- Get or set a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
- </summary>
- <remarks>
- Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
- </remarks>
- <returns>A value, in milliseconds, that determines how long the stream will attempt to write before timing out.</returns>
- <value>The write timeout.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.Position">
- <summary>
- Get or set the position within the current stream.
- </summary>
- <remarks>
- Gets or sets the position within the current stream.
- </remarks>
- <returns>The current position within the stream.</returns>
- <value>The position of the stream.</value>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.Length">
- <summary>
- Get the length of the stream, in bytes.
- </summary>
- <remarks>
- Gets the length of the stream, in bytes.
- </remarks>
- <returns>A long value representing the length of the stream in bytes.</returns>
- <value>The length of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Read(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.ReadResponse(System.Threading.CancellationToken)">
- <summary>
- Read an SMTP server response.
- </summary>
- <remarks>
- Reads a full command response from the SMTP server.
- </remarks>
- <returns>The response.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.ReadResponseAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously read an SMTP server response.
- </summary>
- <remarks>
- Reads a full command response from the SMTP server.
- </remarks>
- <returns>The response.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Write(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <returns>A task that represents the asynchronous write operation.</returns>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Flush(System.Threading.CancellationToken)">
- <summary>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Flush">
- <summary>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.FlushAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <returns>A task that represents the asynchronous flush operation.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- Sets the position within the current stream.
- </summary>
- <returns>The new position within the stream.</returns>
- <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
- <param name="origin">The origin to seek from.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.SetLength(System.Int64)">
- <summary>
- Sets the length of the stream.
- </summary>
- <param name="value">The desired length of the stream in bytes.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support setting the length.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Smtp.SmtpStream"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Smtp.SmtpStream"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Net.Smtp.DeliveryStatusNotificationType">
- <summary>
- Delivery status notification type.
- </summary>
- <remarks>
- The delivery status notification type specifies whether or not
- the full message should be included in any failed DSN issued for
- a message transmission as opposed to just the headers.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Smtp.DeliveryStatusNotificationType.Unspecified">
- <summary>
- The return type is unspecified, allowing the server to choose.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.DeliveryStatusNotificationType.Full">
- <summary>
- The full message should be included in any failed delivery status notification issued by the server.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.DeliveryStatusNotificationType.HeadersOnly">
- <summary>
- Only the headers should be included in any failed delivery status notification issued by the server.
- </summary>
- </member>
- <member name="T:MailKit.Search.AnnotationSearchQuery">
- <summary>
- An annotation-based search query.
- </summary>
- <remarks>
- An annotation-based search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.AnnotationSearchQuery.#ctor(MailKit.AnnotationEntry,MailKit.AnnotationAttribute,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.AnnotationSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new annotation-based search query.
- </remarks>
- <param name="entry">The annotation entry.</param>
- <param name="attribute">The annotation attribute.</param>
- <param name="value">The annotation attribute value.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="entry"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="attribute"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="attribute"/> is not a valid attribute for searching.
- </exception>
- </member>
- <member name="P:MailKit.Search.AnnotationSearchQuery.Entry">
- <summary>
- Get the annotation entry.
- </summary>
- <remarks>
- Gets the annotation entry.
- </remarks>
- <value>The annotation entry.</value>
- </member>
- <member name="P:MailKit.Search.AnnotationSearchQuery.Attribute">
- <summary>
- Get the annotation attribute.
- </summary>
- <remarks>
- Gets the annotation attribute.
- </remarks>
- <value>The annotation attribute.</value>
- </member>
- <member name="P:MailKit.Search.AnnotationSearchQuery.Value">
- <summary>
- Get the annotation attribute value.
- </summary>
- <remarks>
- Gets the annotation attribute value.
- </remarks>
- <value>The annotation attribute value.</value>
- </member>
- <member name="T:MailKit.Search.BinarySearchQuery">
- <summary>
- A binary search query such as an AND or OR expression.
- </summary>
- <remarks>
- A binary search query such as an AND or OR expression.
- </remarks>
- </member>
- <member name="M:MailKit.Search.BinarySearchQuery.#ctor(MailKit.Search.SearchTerm,MailKit.Search.SearchQuery,MailKit.Search.SearchQuery)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.BinarySearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new binary search query.
- </remarks>
- <param name="term">THe search term.</param>
- <param name="left">The left expression.</param>
- <param name="right">The right expression.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="left"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="right"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Search.BinarySearchQuery.Left">
- <summary>
- Gets the left operand of the expression.
- </summary>
- <remarks>
- Gets the left operand of the expression.
- </remarks>
- <value>The left operand.</value>
- </member>
- <member name="P:MailKit.Search.BinarySearchQuery.Right">
- <summary>
- Gets the right operand of the expression.
- </summary>
- <remarks>
- Gets the right operand of the expression.
- </remarks>
- <value>The right operand.</value>
- </member>
- <member name="T:MailKit.Search.DateSearchQuery">
- <summary>
- A date-based search query.
- </summary>
- <remarks>
- A date-based search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.DateSearchQuery.#ctor(MailKit.Search.SearchTerm,System.DateTime)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.DateSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new date-based search query.
- </remarks>
- <param name="term">The search term.</param>
- <param name="date">The date.</param>
- </member>
- <member name="P:MailKit.Search.DateSearchQuery.Date">
- <summary>
- Gets the date value of the search query.
- </summary>
- <remarks>
- Gets the date value of the search query.
- </remarks>
- <value>The date.</value>
- </member>
- <member name="T:MailKit.Search.FilterSearchQuery">
- <summary>
- A filter-based search query.
- </summary>
- <remarks>
- A filter-based search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.FilterSearchQuery.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.FilterSearchQuery"/> class.
- </summary>
- <remarks>
- A search query that references a predefined filter.
- </remarks>
- <param name="name">The name of the filter.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.FilterSearchQuery.#ctor(MailKit.MetadataTag)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.FilterSearchQuery"/> class.
- </summary>
- <remarks>
- A search query that references a predefined filter.
- </remarks>
- <param name="filter">The metadata tag representing the filter.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="filter"/> does not reference a valid filter.
- </exception>
- </member>
- <member name="P:MailKit.Search.FilterSearchQuery.Name">
- <summary>
- Get the name of the filter.
- </summary>
- <remarks>
- Gets the name of the filter.
- </remarks>
- <value>The name of the filter.</value>
- </member>
- <member name="T:MailKit.Search.HeaderSearchQuery">
- <summary>
- A header-based search query.
- </summary>
- <remarks>
- A header-based search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.HeaderSearchQuery.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.HeaderSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new header search query.
- </remarks>
- <param name="field">The header field name.</param>
- <param name="value">The value to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="field"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="value"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="field"/> is empty.
- </exception>
- </member>
- <member name="P:MailKit.Search.HeaderSearchQuery.Field">
- <summary>
- Gets the header field name.
- </summary>
- <remarks>
- Gets the header field name.
- </remarks>
- <value>The header field.</value>
- </member>
- <member name="P:MailKit.Search.HeaderSearchQuery.Value">
- <summary>
- Gets the value to match against.
- </summary>
- <remarks>
- Gets the value to match against.
- </remarks>
- <value>The value.</value>
- </member>
- <member name="T:MailKit.Search.NumericSearchQuery">
- <summary>
- A numeric search query.
- </summary>
- <remarks>
- A numeric search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.NumericSearchQuery.#ctor(MailKit.Search.SearchTerm,System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.NumericSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new numeric search query.
- </remarks>
- <param name="term">The search term.</param>
- <param name="value">The numeric value.</param>
- </member>
- <member name="P:MailKit.Search.NumericSearchQuery.Value">
- <summary>
- Gets the numeric value to match against.
- </summary>
- <remarks>
- Gets the numeric value to match against.
- </remarks>
- <value>The numeric value.</value>
- </member>
- <member name="T:MailKit.Search.OrderBy">
- <summary>
- Specifies a sort order for search results.
- </summary>
- <remarks>
- You can combine multiple <see cref="T:MailKit.Search.OrderBy"/> rules to specify the sort
- order that <see cref="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)"/>
- should return the results in.
- </remarks>
- </member>
- <member name="M:MailKit.Search.OrderBy.#ctor(MailKit.Search.OrderByType,MailKit.Search.SortOrder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.OrderBy"/> class.
- </summary>
- <param name="type">The field to sort by.</param>
- <param name="order">The sort order.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="order"/> cannot be <see cref="F:MailKit.Search.SortOrder.None"/>.
- </exception>
- </member>
- <member name="P:MailKit.Search.OrderBy.Type">
- <summary>
- Gets the field used for sorting.
- </summary>
- <remarks>
- Gets the field used for sorting.
- </remarks>
- <value>The field used for sorting.</value>
- </member>
- <member name="P:MailKit.Search.OrderBy.Order">
- <summary>
- Gets the sort order.
- </summary>
- <remarks>
- Gets the sort order.
- </remarks>
- <value>The sort order.</value>
- </member>
- <member name="F:MailKit.Search.OrderBy.Arrival">
- <summary>
- Sort results by arrival date in ascending order.
- </summary>
- <remarks>
- Sort results by arrival date in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseArrival">
- <summary>
- Sort results by arrival date in desending order.
- </summary>
- <remarks>
- Sort results by arrival date in desending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.Cc">
- <summary>
- Sort results by the first email address in the Cc header in ascending order.
- </summary>
- <remarks>
- Sort results by the first email address in the Cc header in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseCc">
- <summary>
- Sort results by the first email address in the Cc header in descending order.
- </summary>
- <remarks>
- Sort results by the first email address in the Cc header in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.Date">
- <summary>
- Sort results by the sent date in ascending order.
- </summary>
- <remarks>
- Sort results by the sent date in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseDate">
- <summary>
- Sort results by the sent date in descending order.
- </summary>
- <remarks>
- Sort results by the sent date in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.From">
- <summary>
- Sort results by the first email address in the From header in ascending order.
- </summary>
- <remarks>
- Sort results by the first email address in the From header in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseFrom">
- <summary>
- Sort results by the first email address in the From header in descending order.
- </summary>
- <remarks>
- Sort results by the first email address in the From header in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.DisplayFrom">
- <summary>
- Sort results by the first display name in the From header in ascending order.
- </summary>
- <remarks>
- Sort results by the first display name in the From header in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseDisplayFrom">
- <summary>
- Sort results by the first display name in the From header in descending order.
- </summary>
- <remarks>
- Sort results by the first display name in the From header in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.Size">
- <summary>
- Sort results by the message size in ascending order.
- </summary>
- <remarks>
- Sort results by the message size in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseSize">
- <summary>
- Sort results by the message size in descending order.
- </summary>
- <remarks>
- Sort results by the message size in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.Subject">
- <summary>
- Sort results by the Subject header in ascending order.
- </summary>
- <remarks>
- Sort results by the Subject header in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseSubject">
- <summary>
- Sort results by the Subject header in descending order.
- </summary>
- <remarks>
- Sort results by the Subject header in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.To">
- <summary>
- Sort results by the first email address in the To header in ascending order.
- </summary>
- <remarks>
- Sort results by the first email address in the To header in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseTo">
- <summary>
- Sort results by the first email address in the To header in descending order.
- </summary>
- <remarks>
- Sort results by the first email address in the To header in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.DisplayTo">
- <summary>
- Sort results by the first display name in the To header in ascending order.
- </summary>
- <remarks>
- Sort results by the first display name in the To header in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseDisplayTo">
- <summary>
- Sort results by the first display name in the To header in descending order.
- </summary>
- <remarks>
- Sort results by the first display name in the To header in descending order.
- </remarks>
- </member>
- <member name="T:MailKit.Search.OrderByAnnotation">
- <summary>
- Specifies an annotation-based sort order for search results.
- </summary>
- <remarks>
- You can combine multiple <see cref="T:MailKit.Search.OrderBy"/> rules to specify the sort
- order that <see cref="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)"/>
- should return the results in.
- </remarks>
- </member>
- <member name="M:MailKit.Search.OrderByAnnotation.#ctor(MailKit.AnnotationEntry,MailKit.AnnotationAttribute,MailKit.Search.SortOrder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.OrderByAnnotation"/> class.
- </summary>
- <param name="entry">The annotation entry to sort by.</param>
- <param name="attribute">The annotation attribute to use for sorting.</param>
- <param name="order">The sort order.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="entry"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="attribute"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="attribute"/> is not a valid attribute for sorting.
- </exception>
- </member>
- <member name="P:MailKit.Search.OrderByAnnotation.Entry">
- <summary>
- Get the annotation entry.
- </summary>
- <remarks>
- Gets the annotation entry.
- </remarks>
- <value>The annotation entry.</value>
- </member>
- <member name="P:MailKit.Search.OrderByAnnotation.Attribute">
- <summary>
- Get the annotation attribute.
- </summary>
- <remarks>
- Gets the annotation attribute.
- </remarks>
- <value>The annotation attribute.</value>
- </member>
- <member name="T:MailKit.Search.OrderByType">
- <summary>
- The field to sort by.
- </summary>
- <remarks>
- The field to sort by.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderByType.Annotation">
- <summary>
- Sort by an annotation value.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.Arrival">
- <summary>
- Sort by the arrival date.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.Cc">
- <summary>
- Sort by the Cc header.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.Date">
- <summary>
- Sort by the Date header.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.DisplayFrom">
- <summary>
- Sort by the Display Name of the From header.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.DisplayTo">
- <summary>
- Sort by the Display Name of the To header.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.From">
- <summary>
- Sort by the From header.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.ModSeq">
- <summary>
- Sort by the mod-sequence.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.Size">
- <summary>
- Sort by the message size.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.Subject">
- <summary>
- Sort by the message subject.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.To">
- <summary>
- Sort by the To header.
- </summary>
- </member>
- <member name="T:MailKit.Search.SearchOptions">
- <summary>
- Advanced search options.
- </summary>
- <remarks>
- Advanced search options.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchOptions.None">
- <summary>
- No options specified.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchOptions.All">
- <summary>
- Returns all of the matching unique identifiers.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchOptions.Count">
- <summary>
- Returns the number of messages that match the search query.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchOptions.Min">
- <summary>
- Returns the minimum unique identifier of the messages that match the search query.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchOptions.Max">
- <summary>
- Returns the maximum unique identifier of the messages that match the search query.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchOptions.Relevancy">
- <summary>
- Returns the relevancy scores of the messages that match the query. Can only be used
- when using FUZZY search.
- </summary>
- </member>
- <member name="T:MailKit.Search.SearchQuery">
- <summary>
- A specialized query for searching messages in a <see cref="T:MailKit.IMailFolder"/>.
- </summary>
- <remarks>
- A specialized query for searching messages in a <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.SearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Search.SearchQuery"/> that matches all messages.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.#ctor(MailKit.Search.SearchTerm)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.SearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Search.SearchQuery"/> with the specified search term.
- </remarks>
- <param name="term">The search term.</param>
- </member>
- <member name="P:MailKit.Search.SearchQuery.Term">
- <summary>
- Get the search term used by the search query.
- </summary>
- <remarks>
- Gets the search term used by the search query.
- </remarks>
- <value>The term.</value>
- </member>
- <member name="F:MailKit.Search.SearchQuery.All">
- <summary>
- Match all messages in the folder.
- </summary>
- <remarks>
- Matches all messages in the folder.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.And(MailKit.Search.SearchQuery,MailKit.Search.SearchQuery)">
- <summary>
- Create a conditional AND operation.
- </summary>
- <remarks>
- A conditional AND operation only evaluates the second operand if the first operand evaluates to true.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.BinarySearchQuery"/> representing the conditional AND operation.</returns>
- <param name="left">The first operand.</param>
- <param name="right">The second operand.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="left"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="right"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.And(MailKit.Search.SearchQuery)">
- <summary>
- Create a conditional AND operation.
- </summary>
- <remarks>
- A conditional AND operation only evaluates the second operand if the first operand evaluates to true.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.BinarySearchQuery"/> representing the conditional AND operation.</returns>
- <param name="expr">An additional query to execute.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="expr"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.AnnotationsContain(MailKit.AnnotationEntry,MailKit.AnnotationAttribute,System.String)">
- <summary>
- Match messages with the specified annotation.
- </summary>
- <remarks>
- <para>Matches messages with the specified annotation.</para>
- <note type="warning">This feature is not supported by all IMAP servers.</note>
- </remarks>
- <param name="entry">The annotation entry.</param>
- <param name="attribute">The annotation attribute.</param>
- <param name="value">The annotation attribute value.</param>
- <returns>A <see cref="T:MailKit.Search.AnnotationSearchQuery"/>.</returns>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="entry"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="attribute"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="attribute"/> is not a valid attribute for searching.
- </exception>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Answered">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Answered"/> flag set.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Answered"/> flag set.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.BccContains(System.String)">
- <summary>
- Match messages where the Bcc header contains the specified text.
- </summary>
- <remarks>
- Matches messages where the Bcc header contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.BodyContains(System.String)">
- <summary>
- Match messages where the message body contains the specified text.
- </summary>
- <remarks>
- Matches messages where the message body contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.CcContains(System.String)">
- <summary>
- Match messages where the Cc header contains the specified text.
- </summary>
- <remarks>
- Matches messages where the Cc header contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.ChangedSince(System.UInt64)">
- <summary>
- Match messages that have mod-sequence values greater than or equal to the specified mod-sequence value.
- </summary>
- <remarks>
- Matches messages that have mod-sequence values greater than or equal to the specified mod-sequence value.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="modseq">The mod-sequence value.</param>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Deleted">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.DeliveredAfter(System.DateTime)">
- <summary>
- Match messages that were delivered after the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were delivered after the specified date.</para>
- <para>The resolution of this search query does not include the time.</para>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.DeliveredBefore(System.DateTime)">
- <summary>
- Match messages that were delivered before the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were delivered before the specified date.</para>
- <para>The resolution of this search query does not include the time.</para>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.DeliveredOn(System.DateTime)">
- <summary>
- Match messages that were delivered on the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were delivered on the specified date.</para>
- <para>The resolution of this search query does not include the time.</para>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.DoesNotHaveCustomFlag(System.String)">
- <summary>
- Match messages that do not have the specified custom flag set.
- </summary>
- <remarks>
- Matches messages that do not have the specified custom flag set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="flag">The custom flag.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="flag"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="flag"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.DoesNotHaveCustomFlags(System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Match messages that do not have any of the specified custom flags set.
- </summary>
- <remarks>
- Matches messages that do not have any of the specified custom flags set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="flags">The custom flags.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="flags"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="flags"/> is <c>null</c> or empty.</para>
- <para>-or-</para>
- <para>No custom flags were given.</para>
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.DoesNotHaveFlags(MailKit.MessageFlags)">
- <summary>
- Match messages that do not have any of the specified flags set.
- </summary>
- <remarks>
- Matches messages that do not have any of the specified flags set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="flags">The message flags.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="flags"/> does not specify any valid message flags.
- </exception>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Draft">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Draft"/> flag set.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Draft"/> flag set.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Filter(System.String)">
- <summary>
- Match messages using a saved search filter.
- </summary>
- <remarks>
- Matches messages using a saved search filter.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.FilterSearchQuery"/>.</returns>
- <param name="name">The name of the saved search.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Filter(MailKit.MetadataTag)">
- <summary>
- Match messages using a saved search filter.
- </summary>
- <remarks>
- Matches messages using a saved search filter.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.FilterSearchQuery"/>.</returns>
- <param name="filter">The name of the saved search.</param>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Flagged">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Flagged"/> flag set.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Flagged"/> flag set.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.FromContains(System.String)">
- <summary>
- Match messages where the From header contains the specified text.
- </summary>
- <remarks>
- Matches messages where the From header contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Fuzzy(MailKit.Search.SearchQuery)">
- <summary>
- Apply a fuzzy matching algorithm to the specified expression.
- </summary>
- <remarks>
- <para>Applies a fuzzy matching algorithm to the specified expression.</para>
- <note type="warning">This feature is not supported by all IMAP servers.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.UnarySearchQuery"/>.</returns>
- <param name="expr">The expression</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="expr"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HasCustomFlag(System.String)">
- <summary>
- Match messages that have the specified custom flag set.
- </summary>
- <remarks>
- Matches messages that have the specified custom flag set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="flag">The custom flag.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="flag"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="flag"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HasCustomFlags(System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Match messages that have the specified custom flags set.
- </summary>
- <remarks>
- Matches messages that have the specified custom flags set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="flags">The custom flags.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="flags"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="flags"/> is <c>null</c> or empty.</para>
- <para>-or-</para>
- <para>No custom flags were given.</para>
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HasFlags(MailKit.MessageFlags)">
- <summary>
- Match messages that have the specified flags set.
- </summary>
- <remarks>
- Matches messages that have the specified flags set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="flags">The message flags.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="flags"/> does not specify any valid message flags.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.NotFlags(MailKit.MessageFlags)">
- <summary>
- Match messages that do not have any of the specified flags set.
- </summary>
- <remarks>
- Matches messages that do not have any of the specified flags set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="flags">The message flags.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="flags"/> does not specify any valid message flags.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HasKeyword(System.String)">
- <summary>
- Match messages that have the specified keyword set.
- </summary>
- <remarks>
- <para>Matches messages that have the specified keyword set.</para>
- <note type="info">A keyword is a user-defined message flag.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="keyword">The keyword.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keyword"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="keyword"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HasKeywords(System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Match messages that have all of the specified keywords set.
- </summary>
- <remarks>
- <para>Matches messages that have all of the specified keywords set.</para>
- <note type="info">A keyword is a user-defined message flag.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="keywords">The keywords.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keywords"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="keywords"/> is <c>null</c> or empty.</para>
- <para>-or-</para>
- <para>No keywords were given.</para>
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.NotKeyword(System.String)">
- <summary>
- Match messages that do not have the specified keyword set.
- </summary>
- <remarks>
- <para>Matches messages that do not have the specified keyword set.</para>
- <note type="info">A keyword is a user-defined message flag.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="keyword">The keyword.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keyword"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="keyword"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.NotKeywords(System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Match messages that do not have any of the specified keywords set.
- </summary>
- <remarks>
- <para>Matches messages that do not have any of the specified keywords set.</para>
- <note type="info">A keyword is a user-defined message flag.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="keywords">The keywords.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keywords"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="keywords"/> is <c>null</c> or empty.</para>
- <para>-or-</para>
- <para>No keywords were given.</para>
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HeaderContains(System.String,System.String)">
- <summary>
- Match messages where the specified header contains the specified text.
- </summary>
- <remarks>
- Matches messages where the specified header contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.HeaderSearchQuery"/>.</returns>
- <param name="field">The header field to match against.</param>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="field"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="text"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="field"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.LargerThan(System.Int32)">
- <summary>
- Match messages that are larger than the specified number of octets.
- </summary>
- <remarks>
- Matches messages that are larger than the specified number of octets.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
- <param name="octets">The number of octets.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="octets"/> is a negative value.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.MessageContains(System.String)">
- <summary>
- Match messages where the raw message contains the specified text.
- </summary>
- <remarks>
- Matches messages where the raw message contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="F:MailKit.Search.SearchQuery.New">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Recent"/> flag set but not the <see cref="F:MailKit.MessageFlags.Seen"/>.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Recent"/> flag set but not the <see cref="F:MailKit.MessageFlags.Seen"/>.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Not(MailKit.Search.SearchQuery)">
- <summary>
- Create a logical negation of the specified expression.
- </summary>
- <remarks>
- Creates a logical negation of the specified expression.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.UnarySearchQuery"/>.</returns>
- <param name="expr">The expression</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="expr"/> is <c>null</c>.
- </exception>
- </member>
- <member name="F:MailKit.Search.SearchQuery.NotAnswered">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Answered"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Answered"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.NotDeleted">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.NotDraft">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Draft"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Draft"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.NotFlagged">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Flagged"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Flagged"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.NotRecent">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.NotSeen">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Seen"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Seen"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Old">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.OlderThan(System.Int32)">
- <summary>
- Match messages older than the specified number of seconds.
- </summary>
- <remarks>
- Matches messages older than the specified number of seconds.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
- <param name="seconds">The number of seconds.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The number of seconds cannot be less than <c>1</c>.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Or(MailKit.Search.SearchQuery,MailKit.Search.SearchQuery)">
- <summary>
- Create a conditional OR operation.
- </summary>
- <remarks>
- A conditional OR operation only evaluates the second operand if the first operand evaluates to false.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.BinarySearchQuery"/> representing the conditional OR operation.</returns>
- <param name="left">The first operand.</param>
- <param name="right">The second operand.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="left"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="right"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Or(MailKit.Search.SearchQuery)">
- <summary>
- Create a conditional OR operation.
- </summary>
- <remarks>
- A conditional OR operation only evaluates the second operand if the first operand evaluates to true.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.BinarySearchQuery"/> representing the conditional AND operation.</returns>
- <param name="expr">An additional query to execute.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="expr"/> is <c>null</c>.
- </exception>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Recent">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Seen">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Seen"/> flag set.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Seen"/> flag set.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.SentAfter(System.DateTime)">
- <summary>
- Match messages that were sent on or after the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were sent on or after the specified date.</para>
- <para>The resolution of this search query does not include the time.</para>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.SentBefore(System.DateTime)">
- <summary>
- Match messages that were sent before the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were sent before the specified date.</para>
- <note type="note">The resolution of this search query does not include the time.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.SentOn(System.DateTime)">
- <summary>
- Match messages that were sent on the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were sent on the specified date.</para>
- <note type="note">The resolution of this search query does not include the time.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.SentSince(System.DateTime)">
- <summary>
- Match messages that were sent since the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were sent since the specified date.</para>
- <note type="note">The resolution of this search query does not include the time.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.SmallerThan(System.Int32)">
- <summary>
- Match messages that are smaller than the specified number of octets.
- </summary>
- <remarks>
- Matches messages that are smaller than the specified number of octets.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
- <param name="octets">The number of octets.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="octets"/> is a negative value.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.SubjectContains(System.String)">
- <summary>
- Match messages where the Subject header contains the specified text.
- </summary>
- <remarks>
- Matches messages where the Subject header contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.ToContains(System.String)">
- <summary>
- Match messages where the To header contains the specified text.
- </summary>
- <remarks>
- Matches messages where the To header contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Uids(System.Collections.Generic.IList{MailKit.UniqueId})">
- <summary>
- Limit the search query to messages with the specified unique identifiers.
- </summary>
- <remarks>
- Limits the search query to messages with the specified unique identifiers.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.UidSearchQuery"/>.</returns>
- <param name="uids">The unique identifiers.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uids"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.YoungerThan(System.Int32)">
- <summary>
- Match messages younger than the specified number of seconds.
- </summary>
- <remarks>
- Matches messages younger than the specified number of seconds.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
- <param name="seconds">The number of seconds.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The number of seconds cannot be less than <c>1</c>.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.GMailMessageId(System.UInt64)">
- <summary>
- Match messages that have the specified GMail message identifier.
- </summary>
- <remarks>
- This search term can only be used with GMail.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
- <param name="id">The GMail message identifier.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.GMailThreadId(System.UInt64)">
- <summary>
- Match messages belonging to the specified GMail thread.
- </summary>
- <remarks>
- This search term can only be used with GMail.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
- <param name="thread">The GMail thread.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HasGMailLabel(System.String)">
- <summary>
- Match messages that have the specified GMail label.
- </summary>
- <remarks>
- This search term can only be used with GMail.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="label">The GMail label.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="label"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="label"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.GMailRawSearch(System.String)">
- <summary>
- Match messages using the GMail search expression.
- </summary>
- <remarks>
- This search term can only be used with GMail.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="expression">The raw GMail search text.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="expression"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="expression"/> is empty.
- </exception>
- </member>
- <member name="T:MailKit.Search.SearchResults">
- <summary>
- The results of a search.
- </summary>
- <remarks>
- The results of a search.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchResults.#ctor(MailKit.Search.SortOrder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.SearchResults"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Search.SearchResults"/>.
- </remarks>
- <param name="order">The sort-order to use for the unique identifiers.</param>
- </member>
- <member name="P:MailKit.Search.SearchResults.UniqueIds">
- <summary>
- Get or set the unique identifiers of the messages that matched the search query.
- </summary>
- <remarks>
- Gets or sets the unique identifiers of the messages that matched the search query.
- </remarks>
- <value>The unique identifiers.</value>
- </member>
- <member name="P:MailKit.Search.SearchResults.Count">
- <summary>
- Get or set the number of messages that matched the search query.
- </summary>
- <remarks>
- Gets or sets the number of messages that matched the search query.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="P:MailKit.Search.SearchResults.Min">
- <summary>
- Get or set the minimum unique identifier that matched the search query.
- </summary>
- <remarks>
- Gets or sets the minimum unique identifier that matched the search query.
- </remarks>
- <value>The minimum unique identifier.</value>
- </member>
- <member name="P:MailKit.Search.SearchResults.Max">
- <summary>
- Get or set the maximum unique identifier that matched the search query.
- </summary>
- <remarks>
- Gets or sets the maximum unique identifier that matched the search query.
- </remarks>
- <value>The maximum unique identifier.</value>
- </member>
- <member name="P:MailKit.Search.SearchResults.ModSeq">
- <summary>
- Gets or sets the mod-sequence identifier of the messages that matched the search query.
- </summary>
- <remarks>
- Gets or sets the mod-sequence identifier of the messages that matched the search query.
- </remarks>
- <value>The mod-sequence identifier.</value>
- </member>
- <member name="P:MailKit.Search.SearchResults.Relevancy">
- <summary>
- Gets or sets the relevancy scores of the messages that matched the search query.
- </summary>
- <remarks>
- Gets or sets the relevancy scores of the messages that matched the search query.
- </remarks>
- <value>The relevancy scores.</value>
- </member>
- <member name="T:MailKit.Search.SearchTerm">
- <summary>
- A search term.
- </summary>
- <remarks>
- The search term as used by <see cref="T:MailKit.Search.SearchQuery"/>.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchTerm.All">
- <summary>
- A search term that matches all messages.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.And">
- <summary>
- A search term that logically combines 2 or more other
- search expressions such that messages must match both
- expressions.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Annotation">
- <summary>
- A search term that matches messages that have the specified annotation.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Answered">
- <summary>
- A search term that matches answered messages.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.BccContains">
- <summary>
- A search term that matches messages that contain a specified
- string within the <c>Bcc</c> header.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.BodyContains">
- <summary>
- A search term that matches messages that contain a specified
- string within the body of the message.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.CcContains">
- <summary>
- A search term that matches messages that contain a specified
- string within the <c>Cc</c> header.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Deleted">
- <summary>
- A search term that matches deleted messages.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.DeliveredAfter">
- <summary>
- A search term that matches messages delivered after a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.DeliveredBefore">
- <summary>
- A search term that matches messages delivered before a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.DeliveredOn">
- <summary>
- A search term that matches messages delivered on a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Draft">
- <summary>
- A search term that matches draft messages.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Filter">
- <summary>
- A search term that makes use of a predefined filter.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Flagged">
- <summary>
- A search term that matches flagged messages.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.FromContains">
- <summary>
- A search term that matches messages that contain a specified
- string within the <c>From</c> header.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Fuzzy">
- <summary>
- A search term that modifies another search expression to allow
- fuzzy matching.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.HeaderContains">
- <summary>
- A search term that matches messages that contain a specified
- string within a particular header.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Keyword">
- <summary>
- A search term that matches messages that contain a specified
- keyword.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.LargerThan">
- <summary>
- A search term that matches messages that are larger than a
- specified number of bytes.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.MessageContains">
- <summary>
- A search term that matches messages that contain a specified
- string anywhere within the message.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.ModSeq">
- <summary>
- A search term that matches messages that have the specified
- modification sequence value.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.New">
- <summary>
- A search term that matches new messages.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Not">
- <summary>
- A search term that modifies another search expression such that
- messages must match the logical inverse of the expression.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotAnswered">
- <summary>
- A search term that matches messages that have not been answered.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotDeleted">
- <summary>
- A search term that matches messages that have not been deleted.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotDraft">
- <summary>
- A search term that matches messages that are not drafts.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotFlagged">
- <summary>
- A search term that matches messages that have not been flagged.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotKeyword">
- <summary>
- A search term that matches messages that do not contain a specified
- keyword.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotRecent">
- <summary>
- A search term that matches messages that are not recent.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotSeen">
- <summary>
- A search term that matches messages that have not been seen.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Older">
- <summary>
- A search term that matches messages that are older than a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Or">
- <summary>
- A search term that logically combines 2 or more other
- search expressions such that messages only need to match
- one of the expressions.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Recent">
- <summary>
- A search term that matches messages that are recent.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Seen">
- <summary>
- A search term that matches messages that have been seen.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.SentBefore">
- <summary>
- A search term that matches messages that were sent before a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.SentOn">
- <summary>
- A search term that matches messages that were sent on a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.SentSince">
- <summary>
- A search term that matches messages that were sent since a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.SmallerThan">
- <summary>
- A search term that matches messages that are smaller than a
- specified number of bytes.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.SubjectContains">
- <summary>
- A search term that matches messages that contain a specified
- string within the <c>Subject</c> header.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.ToContains">
- <summary>
- A search term that matches messages that contain a specified
- string within the <c>To</c> header.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Uid">
- <summary>
- A search term that matches messages included within a specified
- set of unique identifiers.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Younger">
- <summary>
- A search term that matches messages that are younger than a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.GMailMessageId">
- <summary>
- A search term that matches messages with a specified GMail message identifier.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.GMailThreadId">
- <summary>
- A search term that matches messages with a specified GMail thread (conversation)
- identifier.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.GMailLabels">
- <summary>
- A search term that matches messages with the specified GMail labels.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.GMailRaw">
- <summary>
- A search term that uses the GMail search syntax.
- </summary>
- </member>
- <member name="T:MailKit.Search.SortOrder">
- <summary>
- An enumeration of sort orders.
- </summary>
- <remarks>
- An enumeration of sort orders.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SortOrder.None">
- <summary>
- No sorting order.
- </summary>
- </member>
- <member name="F:MailKit.Search.SortOrder.Ascending">
- <summary>
- Sort in ascending order.
- </summary>
- </member>
- <member name="F:MailKit.Search.SortOrder.Descending">
- <summary>
- Sort in descending order.
- </summary>
- </member>
- <member name="T:MailKit.Search.TextSearchQuery">
- <summary>
- A text-based search query.
- </summary>
- <remarks>
- A text-based search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.TextSearchQuery.#ctor(MailKit.Search.SearchTerm,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.TextSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new text-based search query.
- </remarks>
- <param name="term">The search term.</param>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="P:MailKit.Search.TextSearchQuery.Text">
- <summary>
- Gets the text to match against.
- </summary>
- <remarks>
- Gets the text to match against.
- </remarks>
- <value>The text.</value>
- </member>
- <member name="T:MailKit.Search.UidSearchQuery">
- <summary>
- A unique identifier-based search query.
- </summary>
- <remarks>
- A unique identifier-based search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.UidSearchQuery.#ctor(System.Collections.Generic.IList{MailKit.UniqueId})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.UidSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new unique identifier-based search query.
- </remarks>
- <param name="uids">The unique identifiers to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uids"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.UidSearchQuery.#ctor(MailKit.UniqueId)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.UidSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new unique identifier-based search query.
- </remarks>
- <param name="uid">The unique identifier to match against.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is an invalid unique identifier.
- </exception>
- </member>
- <member name="P:MailKit.Search.UidSearchQuery.Uids">
- <summary>
- Gets the unique identifiers to match against.
- </summary>
- <remarks>
- Gets the unique identifiers to match against.
- </remarks>
- <value>The unique identifiers.</value>
- </member>
- <member name="T:MailKit.Search.UnarySearchQuery">
- <summary>
- A unary search query such as a NOT expression.
- </summary>
- <remarks>
- A unary search query such as a NOT expression.
- </remarks>
- </member>
- <member name="M:MailKit.Search.UnarySearchQuery.#ctor(MailKit.Search.SearchTerm,MailKit.Search.SearchQuery)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.UnarySearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new unary search query.
- </remarks>
- <param name="term">The search term.</param>
- <param name="operand">The operand.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="operand"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.Search.UnarySearchQuery.Operand">
- <summary>
- Gets the inner operand.
- </summary>
- <remarks>
- Gets the inner operand.
- </remarks>
- <value>The operand.</value>
- </member>
- <member name="T:MailKit.Security.Ntlm.NtlmFlags">
- <summary>
- The NTLM message header flags.
- </summary>
- <remarks>
- More details here: http://davenport.sourceforge.net/ntlm.html#theNtlmMessageHeaderLayout
- and at https://msdn.microsoft.com/en-us/library/cc236650.aspx
- </remarks>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateUnicode">
- <summary>
- Indicates that Unicode strings are supported for use in security buffer data.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateOem">
- <summary>
- Indicates that OEM strings are supported for use in security buffer data.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.RequestTarget">
- <summary>
- Requests that the server's authentication realm be included in the Type 2 message.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R10">
- <summary>
- This flag's usage has not been identified.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateSign">
- <summary>
- Specifies that authenticated communication between the client and server should carry a digital signature (message integrity).
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateSeal">
- <summary>
- Specifies that authenticated communication between the client and server should be encrypted (message confidentiality).
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateDatagramStyle">
- <summary>
- Indicates that datagram authentication is being used.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateLanManagerKey">
- <summary>
- Indicates that the Lan Manager Session Key should be used for signing
- and sealing authenticated communications.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R9">
- <summary>
- This flag is unused and MUST be zero. (r8)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateNtlm">
- <summary>
- Indicates that NTLM authentication is being used.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R8">
- <summary>
- This flag is unused and MUST be zero. (r8)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateAnonymous">
- <summary>
- Sent by the client in the Type 3 message to indicate that an anonymous
- context has been established. This also affects the response fields.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateDomainSupplied">
- <summary>
- Sent by the client in the Type 1 message to indicate that the name of the
- domain in which the client workstation has membership is included in the
- message. This is used by the server to determine whether the client is
- eligible for local authentication.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateWorkstationSupplied">
- <summary>
- Sent by the client in the Type 1 message to indicate that the client
- workstation's name is included in the message. This is used by the server
- to determine whether the client is eligible for local authentication.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateLocalCall">
- <summary>
- Sent by the server to indicate that the server and client are on the same
- machine. Implies that the client may use the established local credentials
- for authentication instead of calculating a response to the challenge.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateAlwaysSign">
- <summary>
- Indicates that authenticated communication between the client and server
- should be signed with a "dummy" signature.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.TargetTypeDomain">
- <summary>
- Sent by the server in the Type 2 message to indicate that the target
- authentication realm is a domain.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.TargetTypeServer">
- <summary>
- Sent by the server in the Type 2 message to indicate that the target
- authentication realm is a server.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.TargetTypeShare">
- <summary>
- Sent by the server in the Type 2 message to indicate that the target
- authentication realm is a share. Presumably, this is for share-level
- authentication. Usage is unclear.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateNtlm2Key">
- <summary>
- Indicates that the NTLM2 signing and sealing scheme should be used for
- protecting authenticated communications. Note that this refers to a
- particular session security scheme, and is not related to the use of
- NTLMv2 authentication. This flag can, however, have an effect on the
- response calculations.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateIdentify">
- <summary>
- This flag's usage has not been identified.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R5">
- <summary>
- This flag is unused and MUST be zero. (r5)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.RequestNonNTSessionKey">
- <summary>
- Indicates that the LMOWF function should be used to generate a session key.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateTargetInfo">
- <summary>
- Sent by the server in the Type 2 message to indicate that it is including
- a Target Information block in the message. The Target Information block
- is used in the calculation of the NTLMv2 response.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R4">
- <summary>
- This flag is unused and MUST be zero. (r4)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateVersion">
- <summary>
- Indicates that the version field is present.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R3">
- <summary>
- This flag is unused and MUST be zero. (r3)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R2">
- <summary>
- This flag is unused and MUST be zero. (r2)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R1">
- <summary>
- This flag is unused and MUST be zero. (r1)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.Negotiate128">
- <summary>
- Indicates that 128-bit encryption is supported.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateKeyExchange">
- <summary>
- Indicates that the client will provide an encrypted master key in the
- "Session Key" field of the Type 3 message.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.Negotiate56">
- <summary>
- Indicates that 56-bit encryption is supported.
- </summary>
- </member>
- <member name="T:MailKit.Security.AuthenticationException">
- <summary>
- The exception that is thrown when there is an authentication error.
- </summary>
- <remarks>
- The exception that is thrown when there is an authentication error.
- </remarks>
- </member>
- <member name="M:MailKit.Security.AuthenticationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.AuthenticationException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.AuthenticationException"/> from the seriaized data.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.AuthenticationException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.AuthenticationException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.AuthenticationException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.Security.AuthenticationException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.AuthenticationException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.AuthenticationException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Security.AuthenticationException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.AuthenticationException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.AuthenticationException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.Security.SaslErrorCode">
- <summary>
- An enumeration of the possible error codes that may be reported by a <see cref="T:MailKit.Security.SaslException"/>.
- </summary>
- <remarks>
- An enumeration of the possible error codes that may be reported by a <see cref="T:MailKit.Security.SaslException"/>.
- </remarks>
- </member>
- <member name="F:MailKit.Security.SaslErrorCode.ChallengeTooLong">
- <summary>
- The server's challenge was too long.
- </summary>
- </member>
- <member name="F:MailKit.Security.SaslErrorCode.IncompleteChallenge">
- <summary>
- The server's response contained an incomplete challenge.
- </summary>
- </member>
- <member name="F:MailKit.Security.SaslErrorCode.InvalidChallenge">
- <summary>
- The server's challenge was invalid.
- </summary>
- </member>
- <member name="F:MailKit.Security.SaslErrorCode.MissingChallenge">
- <summary>
- The server's response did not contain a challenge.
- </summary>
- </member>
- <member name="F:MailKit.Security.SaslErrorCode.IncorrectHash">
- <summary>
- The server's challenge contained an incorrect hash.
- </summary>
- </member>
- <member name="T:MailKit.Security.SaslException">
- <summary>
- A SASL authentication exception.
- </summary>
- <remarks>
- Typically indicates an error while parsing a server's challenge token.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslException"/> class.
- </summary>
- <remarks>
- Deserializes a <see cref="T:MailKit.Security.SaslException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- </member>
- <member name="M:MailKit.Security.SaslException.#ctor(System.String,MailKit.Security.SaslErrorCode,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.SaslException"/>.
- </remarks>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="code">The error code.</param>
- <param name="message">The error message.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
- with information about the exception.
- </summary>
- <remarks>
- Serializes the state of the <see cref="T:MailKit.Security.SaslException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslException.ErrorCode">
- <summary>
- Gets the error code.
- </summary>
- <remarks>
- Gets the error code.
- </remarks>
- <value>The error code.</value>
- </member>
- <member name="P:MailKit.Security.SaslException.Mechanism">
- <summary>
- Gets the name of the SASL mechanism that had the error.
- </summary>
- <remarks>
- Gets the name of the SASL mechanism that had the error.
- </remarks>
- <value>The name of the SASL mechanism.</value>
- </member>
- <member name="T:MailKit.Security.SaslMechanism">
- <summary>
- A SASL authentication mechanism.
- </summary>
- <remarks>
- Authenticating via a SASL mechanism may be a multi-step process.
- To determine if the mechanism has completed the necessary steps
- to authentication, check the <see cref="P:MailKit.Security.SaslMechanism.IsAuthenticated"/> after
- each call to <see cref="M:MailKit.Security.SaslMechanism.Challenge(System.String)"/>.
- </remarks>
- </member>
- <member name="F:MailKit.Security.SaslMechanism.AuthMechanismRank">
- <summary>
- The supported authentication mechanisms in order of strongest to weakest.
- </summary>
- <remarks>
- Used by the various clients when authenticating via SASL to determine
- which order the SASL mechanisms supported by the server should be tried.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanism"/> class.
- </summary>
- <remarks>
- Creates a new SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanism"/> class.
- </summary>
- <remarks>
- Creates a new SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanism"/> class.
- </summary>
- <remarks>
- Creates a new SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanism"/> class.
- </summary>
- <remarks>
- Creates a new SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanism.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanism.Credentials">
- <summary>
- Gets the user's credentials.
- </summary>
- <remarks>
- Gets the user's credentials.
- </remarks>
- <value>The user's credentials.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanism.SupportsInitialResponse">
- <summary>
- Gets whether or not the mechanism supports an initial response (SASL-IR).
- </summary>
- <remarks>
- SASL mechanisms that support sending an initial client response to the server
- should return <value>true</value>.
- </remarks>
- <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanism.IsAuthenticated">
- <summary>
- Gets or sets whether the SASL mechanism has finished authenticating.
- </summary>
- <remarks>
- Gets or sets whether the SASL mechanism has finished authenticating.
- </remarks>
- <value><c>true</c> if the SASL mechanism has finished authenticating; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanism.NegotiatedSecurityLayer">
- <summary>
- Gets whether or not a security layer was negotiated.
- </summary>
- <remarks>
- <para>Gets whether or not a security layer has been negotiated by the SASL mechanism.</para>
- <note type="note">Some SASL mechanisms, such as GSSAPI, are able to negotiate security layers
- such as integrity and confidentiality protection.</note>
- </remarks>
- <value><c>true</c> if a security layer was negotiated; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanism.Uri">
- <summary>
- Gets or sets the URI of the service.
- </summary>
- <remarks>
- Gets or sets the URI of the service.
- </remarks>
- <value>The URI of the service.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- THe SASL mechanism does not support SASL-IR.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.Challenge(System.String)">
- <summary>
- Decodes the base64-encoded server challenge and returns the next challenge response encoded in base64.
- </summary>
- <remarks>
- Decodes the base64-encoded server challenge and returns the next challenge response encoded in base64.
- </remarks>
- <returns>The next base64-encoded challenge response.</returns>
- <param name="token">The server's base64-encoded challenge token.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- THe SASL mechanism does not support SASL-IR.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.Reset">
- <summary>
- Resets the state of the SASL mechanism.
- </summary>
- <remarks>
- Resets the state of the SASL mechanism.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.IsSupported(System.String)">
- <summary>
- Determines if the specified SASL mechanism is supported by MailKit.
- </summary>
- <remarks>
- Use this method to make sure that a SASL mechanism is supported before calling
- <see cref="M:MailKit.Security.SaslMechanism.Create(System.String,System.Uri,System.Net.ICredentials)"/>.
- </remarks>
- <returns><c>true</c> if the specified SASL mechanism is supported; otherwise, <c>false</c>.</returns>
- <param name="mechanism">The name of the SASL mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.Create(System.String,System.Uri,System.Text.Encoding,System.Net.ICredentials)">
- <summary>
- Create an instance of the specified SASL mechanism using the uri and credentials.
- </summary>
- <remarks>
- If unsure that a particular SASL mechanism is supported, you should first call
- <see cref="M:MailKit.Security.SaslMechanism.IsSupported(System.String)"/>.
- </remarks>
- <returns>An instance of the requested SASL mechanism if supported; otherwise <c>null</c>.</returns>
- <param name="mechanism">The name of the SASL mechanism.</param>
- <param name="uri">The URI of the service to authenticate against.</param>
- <param name="encoding">The text encoding to use for the credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="mechanism"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.Create(System.String,System.Uri,System.Net.ICredentials)">
- <summary>
- Create an instance of the specified SASL mechanism using the uri and credentials.
- </summary>
- <remarks>
- If unsure that a particular SASL mechanism is supported, you should first call
- <see cref="M:MailKit.Security.SaslMechanism.IsSupported(System.String)"/>.
- </remarks>
- <returns>An instance of the requested SASL mechanism if supported; otherwise <c>null</c>.</returns>
- <param name="mechanism">The name of the SASL mechanism.</param>
- <param name="uri">The URI of the service to authenticate against.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="mechanism"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.IsNonAsciiSpace(System.Char)">
- <summary>
- Determines if the character is a non-ASCII space.
- </summary>
- <remarks>
- This list was obtained from http://tools.ietf.org/html/rfc3454#appendix-C.1.2
- </remarks>
- <returns><c>true</c> if the character is a non-ASCII space; otherwise, <c>false</c>.</returns>
- <param name="c">The character.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.IsCommonlyMappedToNothing(System.Char)">
- <summary>
- Determines if the character is commonly mapped to nothing.
- </summary>
- <remarks>
- This list was obtained from http://tools.ietf.org/html/rfc3454#appendix-B.1
- </remarks>
- <returns><c>true</c> if the character is commonly mapped to nothing; otherwise, <c>false</c>.</returns>
- <param name="c">The character.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.IsProhibited(System.String,System.Int32)">
- <summary>
- Determines if the character is prohibited.
- </summary>
- <remarks>
- This list was obtained from http://tools.ietf.org/html/rfc3454#appendix-C.3
- </remarks>
- <returns><c>true</c> if the character is prohibited; otherwise, <c>false</c>.</returns>
- <param name="s">The string.</param>
- <param name="index">The character index.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.SaslPrep(System.String)">
- <summary>
- Prepares the user name or password string.
- </summary>
- <remarks>
- Prepares a user name or password string according to the rules of rfc4013.
- </remarks>
- <returns>The prepared string.</returns>
- <param name="s">The string to prepare.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="s"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="s"/> contains prohibited characters.
- </exception>
- </member>
- <member name="T:MailKit.Security.SaslMechanismCramMd5">
- <summary>
- The CRAM-MD5 SASL mechanism.
- </summary>
- <remarks>
- A SASL mechanism based on HMAC-MD5.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismCramMd5.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismCramMd5"/> class.
- </summary>
- <remarks>
- Creates a new CRAM-MD5 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismCramMd5.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismCramMd5"/> class.
- </summary>
- <remarks>
- Creates a new CRAM-MD5 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismCramMd5.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismCramMd5"/> class.
- </summary>
- <remarks>
- Creates a new CRAM-MD5 SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismCramMd5.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismCramMd5"/> class.
- </summary>
- <remarks>
- Creates a new CRAM-MD5 SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismCramMd5.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismCramMd5.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The SASL mechanism does not support SASL-IR.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="T:MailKit.Security.SaslMechanismDigestMd5">
- <summary>
- The DIGEST-MD5 SASL mechanism.
- </summary>
- <remarks>
- Unlike the PLAIN and LOGIN SASL mechanisms, the DIGEST-MD5 mechanism
- provides some level of protection and should be relatively safe to
- use even with a clear-text connection.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismDigestMd5.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismDigestMd5"/> class.
- </summary>
- <remarks>
- Creates a new DIGEST-MD5 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismDigestMd5.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismDigestMd5"/> class.
- </summary>
- <remarks>
- Creates a new DIGEST-MD5 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismDigestMd5.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismDigestMd5"/> class.
- </summary>
- <remarks>
- Creates a new DIGEST-MD5 SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismDigestMd5.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismDigestMd5"/> class.
- </summary>
- <remarks>
- Creates a new DIGEST-MD5 SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismDigestMd5.AuthorizationId">
- <summary>
- Gets or sets the authorization identifier.
- </summary>
- <remarks>
- The authorization identifier is the desired user account that the server should use
- for all accesses. This is separate from the user name used for authentication.
- </remarks>
- <value>The authorization identifier.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismDigestMd5.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismDigestMd5.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- THe SASL mechanism does not support SASL-IR.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismDigestMd5.Reset">
- <summary>
- Resets the state of the SASL mechanism.
- </summary>
- <remarks>
- Resets the state of the SASL mechanism.
- </remarks>
- </member>
- <member name="T:MailKit.Security.SaslMechanismLogin">
- <summary>
- The LOGIN SASL mechanism.
- </summary>
- <remarks>
- The LOGIN SASL mechanism provides little protection over the use
- of plain-text passwords by obscuring the user name and password within
- individual base64-encoded blobs and should be avoided unless used in
- combination with an SSL or TLS connection.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Uri,System.Text.Encoding,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Uri,System.Text.Encoding,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Text.Encoding,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Text.Encoding,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismLogin.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismLogin.SupportsInitialResponse">
- <summary>
- Gets whether or not the mechanism supports an initial response (SASL-IR).
- </summary>
- <remarks>
- SASL mechanisms that support sending an initial client response to the server
- should return <value>true</value>.
- </remarks>
- <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The SASL mechanism does not support SASL-IR.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.Reset">
- <summary>
- Resets the state of the SASL mechanism.
- </summary>
- <remarks>
- Resets the state of the SASL mechanism.
- </remarks>
- </member>
- <member name="T:MailKit.Security.SaslMechanismNtlm">
- <summary>
- The NTLM SASL mechanism.
- </summary>
- <remarks>
- A SASL mechanism based on NTLM.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismNtlm.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismNtlm"/> class.
- </summary>
- <remarks>
- Creates a new NTLM SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismNtlm.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismNtlm"/> class.
- </summary>
- <remarks>
- Creates a new NTLM SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismNtlm.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismNtlm"/> class.
- </summary>
- <remarks>
- Creates a new NTLM SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismNtlm.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismNtlm"/> class.
- </summary>
- <remarks>
- Creates a new NTLM SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismNtlm.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismNtlm.SupportsInitialResponse">
- <summary>
- Gets whether or not the mechanism supports an initial response (SASL-IR).
- </summary>
- <remarks>
- SASL mechanisms that support sending an initial client response to the server
- should return <value>true</value>.
- </remarks>
- <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismNtlm.Workstation">
- <summary>
- Gets or sets the workstation name to use for authentication.
- </summary>
- <remarks>
- Gets or sets the workstation name to use for authentication.
- </remarks>
- <value>The workstation name.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismNtlm.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismNtlm.Reset">
- <summary>
- Resets the state of the SASL mechanism.
- </summary>
- <remarks>
- Resets the state of the SASL mechanism.
- </remarks>
- </member>
- <member name="T:MailKit.Security.SaslMechanismOAuth2">
- <summary>
- The OAuth2 SASL mechanism.
- </summary>
- <remarks>
- A SASL mechanism used by Google that makes use of a short-lived
- OAuth 2.0 access token.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismOAuth2.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismOAuth2"/> class.
- </summary>
- <remarks>
- Creates a new XOAUTH2 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismOAuth2.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismOAuth2"/> class.
- </summary>
- <remarks>
- Creates a new XOAUTH2 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="auth_token">The auth token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="auth_token"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismOAuth2.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismOAuth2"/> class.
- </summary>
- <remarks>
- Creates a new XOAUTH2 SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismOAuth2.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismOAuth2"/> class.
- </summary>
- <remarks>
- Creates a new XOAUTH2 SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="auth_token">The auth token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="auth_token"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismOAuth2.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismOAuth2.SupportsInitialResponse">
- <summary>
- Gets whether or not the mechanism supports an initial response (SASL-IR).
- </summary>
- <remarks>
- SASL mechanisms that support sending an initial client response to the server
- should return <value>true</value>.
- </remarks>
- <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismOAuth2.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="T:MailKit.Security.SaslMechanismPlain">
- <summary>
- The PLAIN SASL mechanism.
- </summary>
- <remarks>
- The PLAIN SASL mechanism provides little protection over the use
- of plain-text passwords by combining the user name and password and
- obscuring them within a base64-encoded blob and should be avoided
- unless used in combination with an SSL or TLS connection.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Uri,System.Text.Encoding,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Uri,System.Text.Encoding,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Text.Encoding,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Text.Encoding,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismPlain.AuthorizationId">
- <summary>
- Gets or sets the authorization identifier.
- </summary>
- <remarks>
- The authorization identifier is the desired user account that the server should use
- for all accesses. This is separate from the user name used for authentication.
- </remarks>
- <value>The authorization identifier.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismPlain.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismPlain.SupportsInitialResponse">
- <summary>
- Gets whether or not the mechanism supports an initial response (SASL-IR).
- </summary>
- <remarks>
- SASL mechanisms that support sending an initial client response to the server
- should return <value>true</value>.
- </remarks>
- <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="T:MailKit.Security.SaslMechanismScramBase">
- <summary>
- The base class for SCRAM-based SASL mechanisms.
- </summary>
- <remarks>
- SCRAM-based SASL mechanisms are salted challenge/response authentication mechanisms.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramBase"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-based SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramBase"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-based SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramBase"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-based SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramBase"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-based SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismScramBase.SupportsInitialResponse">
- <summary>
- Gets whether or not the mechanism supports an initial response (SASL-IR).
- </summary>
- <remarks>
- SASL mechanisms that support sending an initial client response to the server
- should return <value>true</value>.
- </remarks>
- <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.CreateHMAC(System.Byte[])">
- <summary>
- Create the HMAC context.
- </summary>
- <remarks>
- Creates the HMAC context using the secret key.
- </remarks>
- <returns>The HMAC context.</returns>
- <param name="key">The secret key.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.HMAC(System.Byte[],System.Byte[])">
- <summary>
- Apply the HMAC keyed algorithm.
- </summary>
- <remarks>
- HMAC(key, str): Apply the HMAC keyed hash algorithm (defined in
- [RFC2104]) using the octet string represented by "key" as the key
- and the octet string "str" as the input string. The size of the
- result is the hash result size for the hash function in use. For
- example, it is 20 octets for SHA-1 (see [RFC3174]).
- </remarks>
- <returns>The results of the HMAC keyed algorithm.</returns>
- <param name="key">The key.</param>
- <param name="str">The string.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.Hash(System.Byte[])">
- <summary>
- Apply the cryptographic hash function.
- </summary>
- <remarks>
- H(str): Apply the cryptographic hash function to the octet string
- "str", producing an octet string as a result. The size of the
- result depends on the hash result size for the hash function in
- use.
- </remarks>
- <returns>The results of the hash.</returns>
- <param name="str">The string.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.Xor(System.Byte[],System.Byte[])">
- <summary>
- Apply the exclusive-or operation to combine two octet strings.
- </summary>
- <remarks>
- Apply the exclusive-or operation to combine the octet string
- on the left of this operator with the octet string on the right of
- this operator. The length of the output and each of the two
- inputs will be the same for this use.
- </remarks>
- <param name="a">The alpha component.</param>
- <param name="b">The blue component.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.Reset">
- <summary>
- Resets the state of the SASL mechanism.
- </summary>
- <remarks>
- Resets the state of the SASL mechanism.
- </remarks>
- </member>
- <member name="T:MailKit.Security.SaslMechanismScramSha1">
- <summary>
- The SCRAM-SHA-1 SASL mechanism.
- </summary>
- <remarks>
- A salted challenge/response SASL mechanism that uses the HMAC SHA-1 algorithm.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha1.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha1"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-1 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha1.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha1"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-1 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha1.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha1"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-1 SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha1.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha1"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-1 SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismScramSha1.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha1.CreateHMAC(System.Byte[])">
- <summary>
- Create the HMAC context.
- </summary>
- <remarks>
- Creates the HMAC context using the secret key.
- </remarks>
- <returns>The HMAC context.</returns>
- <param name="key">The secret key.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha1.Hash(System.Byte[])">
- <summary>
- Apply the cryptographic hash function.
- </summary>
- <remarks>
- H(str): Apply the cryptographic hash function to the octet string
- "str", producing an octet string as a result. The size of the
- result depends on the hash result size for the hash function in
- use.
- </remarks>
- <returns>The results of the hash.</returns>
- <param name="str">The string.</param>
- </member>
- <member name="T:MailKit.Security.SaslMechanismScramSha256">
- <summary>
- The SCRAM-SHA-256 SASL mechanism.
- </summary>
- <remarks>
- A salted challenge/response SASL mechanism that uses the HMAC SHA-256 algorithm.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha256.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha256"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-256 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha256.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha256"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-256 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha256.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha256"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-256 SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha256.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha256"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-256 SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismScramSha256.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha256.CreateHMAC(System.Byte[])">
- <summary>
- Create the HMAC context.
- </summary>
- <remarks>
- Creates the HMAC context using the secret key.
- </remarks>
- <returns>The HMAC context.</returns>
- <param name="key">The secret key.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha256.Hash(System.Byte[])">
- <summary>
- Apply the cryptographic hash function.
- </summary>
- <remarks>
- H(str): Apply the cryptographic hash function to the octet string
- "str", producing an octet string as a result. The size of the
- result depends on the hash result size for the hash function in
- use.
- </remarks>
- <returns>The results of the hash.</returns>
- <param name="str">The string.</param>
- </member>
- <member name="T:MailKit.Security.SecureSocketOptions">
- <summary>
- Secure socket options.
- </summary>
- <remarks>
- Provides a way of specifying the SSL and/or TLS encryption that
- should be used for a connection.
- </remarks>
- </member>
- <member name="F:MailKit.Security.SecureSocketOptions.None">
- <summary>
- No SSL or TLS encryption should be used.
- </summary>
- </member>
- <member name="F:MailKit.Security.SecureSocketOptions.Auto">
- <summary>
- Allow the <see cref="T:MailKit.IMailService"/> to decide which SSL or TLS
- options to use (default). If the server does not support SSL or TLS,
- then the connection will continue without any encryption.
- </summary>
- </member>
- <member name="F:MailKit.Security.SecureSocketOptions.SslOnConnect">
- <summary>
- The connection should use SSL or TLS encryption immediately.
- </summary>
- </member>
- <member name="F:MailKit.Security.SecureSocketOptions.StartTls">
- <summary>
- Elevates the connection to use TLS encryption immediately after
- reading the greeting and capabilities of the server. If the server
- does not support the STARTTLS extension, then the connection will
- fail and a <see cref="T:System.NotSupportedException"/> will be thrown.
- </summary>
- </member>
- <member name="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable">
- <summary>
- Elevates the connection to use TLS encryption immediately after
- reading the greeting and capabilities of the server, but only if
- the server supports the STARTTLS extension.
- </summary>
- </member>
- <member name="T:MailKit.Security.SslHandshakeException">
- <summary>
- The exception that is thrown when there is an error during the SSL/TLS handshake.
- </summary>
- <remarks>
- <para>The exception that is thrown when there is an error during the SSL/TLS handshake.</para>
- <para>When this exception occurrs, it typically means that the IMAP, POP3 or SMTP server that
- you are connecting to is using an SSL certificate that is either expired or untrusted by
- your system.</para>
- <para>Often times, mail servers will use self-signed certificates instead of using a certificate
- that has been signed by a trusted Certificate Authority. When your system is unable to validate
- the mail server's certificate because it is not signed by a known and trusted Certificate Authority,
- this exception will occur.</para>
- <para>You can work around this problem by supplying a custom <see cref="T:System.Net.Security.RemoteCertificateValidationCallback"/>
- and setting it on the client's <see cref="P:MailKit.MailService.ServerCertificateValidationCallback"/> property.</para>
- <para>Most likely, you'll want to compare the thumbprint of the server's certificate with a known
- value and/or prompt the user to accept the certificate (similar to what you've probably seen web
- browsers do when they encounter untrusted certificates).</para>
- </remarks>
- </member>
- <member name="M:MailKit.Security.SslHandshakeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SslHandshakeException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.SslHandshakeException"/> from the seriaized data.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SslHandshakeException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SslHandshakeException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.SslHandshakeException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.Security.SslHandshakeException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SslHandshakeException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.SslHandshakeException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Security.SslHandshakeException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SslHandshakeException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.SslHandshakeException"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Security.SslHandshakeException.ServerCertificate">
- <summary>
- Get the server's SSL certificate.
- </summary>
- <remarks>
- Gets the server's SSL certificate, if it is available.
- </remarks>
- <value>The server's SSL certificate.</value>
- </member>
- <member name="P:MailKit.Security.SslHandshakeException.RootCertificateAuthority">
- <summary>
- Get the certificate for the Root Certificate Authority.
- </summary>
- <remarks>
- Gets the certificate for the Root Certificate Authority, if it is available.
- </remarks>
- <value>The Root Certificate Authority certificate.</value>
- </member>
- <member name="M:MailKit.Security.SslHandshakeException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
- with information about the exception.
- </summary>
- <remarks>
- Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
- with information about the exception.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.AccessControl">
- <summary>
- An Access Control.
- </summary>
- <remarks>
- An Access Control is a set of permissions available for a particular identity,
- controlling whether or not that identity has the ability to perform various tasks.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="M:MailKit.AccessControl.#ctor(System.String,System.Collections.Generic.IEnumerable{MailKit.AccessRight})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessControl"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AccessControl"/> with the given name and
- access rights.
- </remarks>
- <param name="name">The identifier name.</param>
- <param name="rights">The access rights.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.AccessControl.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessControl"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AccessControl"/> with the given name and
- access rights.
- </remarks>
- <param name="name">The identifier name.</param>
- <param name="rights">The access rights.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.AccessControl.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessControl"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AccessControl"/> with the given name and no
- access rights.
- </remarks>
- <param name="name">The identifier name.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.AccessControl.Name">
- <summary>
- The identifier name for the access control.
- </summary>
- <remarks>
- The identifier name for the access control.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The identifier name.</value>
- </member>
- <member name="P:MailKit.AccessControl.Rights">
- <summary>
- Get the access rights.
- </summary>
- <remarks>
- Gets the access rights.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The access rights.</value>
- </member>
- <member name="T:MailKit.AccessControlList">
- <summary>
- An Access Control List (ACL)
- </summary>
- <remarks>
- An Access Control List (ACL) is a list of access controls defining the permissions
- various identities have available.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="M:MailKit.AccessControlList.#ctor(System.Collections.Generic.IEnumerable{MailKit.AccessControl})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessControlList"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AccessControlList"/>.
- </remarks>
- <param name="controls">The list of access controls.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="controls"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.AccessControlList.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessControlList"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AccessControlList"/>.
- </remarks>
- </member>
- <member name="T:MailKit.AccessRight">
- <summary>
- An individual Access Right to be used with ACLs.
- </summary>
- <remarks>
- <para>An individual Access Right meant to be used with
- <see cref="T:MailKit.AccessControlList"/>.</para>
- <para>For more information on what rights are available,
- see https://tools.ietf.org/html/rfc4314#section-2.1
- </para>
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.LookupFolder">
- <summary>
- The access right for folder lookups.
- </summary>
- <remarks>
- Allows the <see cref="T:MailKit.IMailFolder"/> to be visible when listing folders.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.OpenFolder">
- <summary>
- The access right for opening a folder and getting the status.
- </summary>
- <remarks>
- Provides access for opening and getting the status of the folder.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.SetMessageSeen">
- <summary>
- The access right for adding or removing the Seen flag on messages in the folder.
- </summary>
- <remarks>
- Provides access to add or remove the <see cref="F:MailKit.MessageFlags.Seen"/> flag on messages within the
- <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.SetMessageFlags">
- <summary>
- The access right for adding or removing flags (other than Seen and Deleted)
- on messages in a folder.
- </summary>
- <remarks>
- Provides access to add or remove the <see cref="T:MailKit.MessageFlags"/> on messages
- (other than <see cref="F:MailKit.MessageFlags.Seen"/> and
- <see cref="F:MailKit.MessageFlags.Deleted"/>) within the folder.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.AppendMessages">
- <summary>
- The access right allowing messages to be appended or copied into the folder.
- </summary>
- <remarks>
- Provides access to append or copy messages into the folder.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.CreateFolder">
- <summary>
- The access right allowing subfolders to be created.
- </summary>
- <remarks>
- Provides access to create subfolders.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.DeleteFolder">
- <summary>
- The access right for deleting a folder and/or its subfolders.
- </summary>
- <remarks>
- Provides access to delete the folder and/or any subfolders.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.SetMessageDeleted">
- <summary>
- The access right for adding or removing the Deleted flag to messages within a folder.
- </summary>
- <remarks>
- Provides access to add or remove the <see cref="F:MailKit.MessageFlags.Deleted"/> flag from
- messages within the folder. It also provides access for setting the
- <see cref="F:MailKit.MessageFlags.Deleted"/> flag when appending a message to a folder.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.ExpungeFolder">
- <summary>
- The access right for expunging deleted messages in a folder.
- </summary>
- <remarks>
- Provides access to expunge deleted messages in a folder.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.Administer">
- <summary>
- The access right for administering the ACLs of a folder.
- </summary>
- <remarks>
- Provides administrative access to change the ACLs for the folder.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.Right">
- <summary>
- The character representing the particular access right.
- </summary>
- <remarks>
- Represents the character value of the access right.
- </remarks>
- </member>
- <member name="M:MailKit.AccessRight.#ctor(System.Char)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessRight"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AccessRight"/> struct.
- </remarks>
- <param name="right">The access right.</param>
- </member>
- <member name="M:MailKit.AccessRight.Equals(MailKit.AccessRight)">
- <summary>
- Determines whether the specified <see cref="T:MailKit.AccessRight"/> is equal to the current <see cref="T:MailKit.AccessRight"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:MailKit.AccessRight"/> is equal to the current <see cref="T:MailKit.AccessRight"/>.
- </remarks>
- <param name="other">The <see cref="T:MailKit.AccessRight"/> to compare with the current <see cref="T:MailKit.AccessRight"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:MailKit.AccessRight"/> is equal to the current
- <see cref="T:MailKit.AccessRight"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.AccessRight.op_Equality(MailKit.AccessRight,MailKit.AccessRight)">
- <summary>
- Determines whether two access rights are equal.
- </summary>
- <remarks>
- Determines whether two access rights are equal.
- </remarks>
- <returns><c>true</c> if <paramref name="right1"/> and <paramref name="right2"/> are equal; otherwise, <c>false</c>.</returns>
- <param name="right1">The first access right to compare.</param>
- <param name="right2">The second access right to compare.</param>
- </member>
- <member name="M:MailKit.AccessRight.op_Inequality(MailKit.AccessRight,MailKit.AccessRight)">
- <summary>
- Determines whether two access rights are not equal.
- </summary>
- <remarks>
- Determines whether two access rights are not equal.
- </remarks>
- <returns><c>true</c> if <paramref name="right1"/> and <paramref name="right2"/> are not equal; otherwise, <c>false</c>.</returns>
- <param name="right1">The first access right to compare.</param>
- <param name="right2">The second access right to compare.</param>
- </member>
- <member name="M:MailKit.AccessRight.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AccessRight"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AccessRight"/>.
- </remarks>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.AccessRight"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AccessRight"/>;
- otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.AccessRight.GetHashCode">
- <summary>
- Serves as a hash function for a <see cref="T:MailKit.AccessRight"/> object.
- </summary>
- <remarks>
- Serves as a hash function for a <see cref="T:MailKit.AccessRight"/> object.
- </remarks>
- <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
- </member>
- <member name="M:MailKit.AccessRight.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRight"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRight"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRight"/>.</returns>
- </member>
- <member name="T:MailKit.AccessRights">
- <summary>
- A set of access rights.
- </summary>
- <remarks>
- The set of access rights for a particular identity.
- </remarks>
- </member>
- <member name="M:MailKit.AccessRights.#ctor(System.Collections.Generic.IEnumerable{MailKit.AccessRight})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessRights"/> class.
- </summary>
- <remarks>
- Creates a new set of access rights.
- </remarks>
- <param name="rights">The access rights.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="rights"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.AccessRights.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessRights"/> class.
- </summary>
- <remarks>
- Creates a new set of access rights.
- </remarks>
- <param name="rights">The access rights.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="rights"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.AccessRights.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessRights"/> class.
- </summary>
- <remarks>
- Creates an empty set of access rights.
- </remarks>
- </member>
- <member name="P:MailKit.AccessRights.Count">
- <summary>
- Get the number of access rights in the collection.
- </summary>
- <remarks>
- Gets the number of access rights in the collection.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="P:MailKit.AccessRights.IsReadOnly">
- <summary>
- Get whether or not this set of access rights is read only.
- </summary>
- <remarks>
- Gets whether or not this set of access rights is read only.
- </remarks>
- <value><c>true</c> if this collection is read only; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.AccessRights.System#Collections#Generic#ICollection{MailKit#AccessRight}#Add(MailKit.AccessRight)">
- <summary>
- Add the specified access right.
- </summary>
- <remarks>
- Adds the specified access right if it is not already included.
- </remarks>
- <param name="right">The access right.</param>
- </member>
- <member name="M:MailKit.AccessRights.Add(MailKit.AccessRight)">
- <summary>
- Add the specified access right.
- </summary>
- <remarks>
- Adds the specified access right if it is not already included.
- </remarks>
- <returns><c>true</c> if the right was added; otherwise, <c>false</c>.</returns>
- <param name="right">The access right.</param>
- </member>
- <member name="M:MailKit.AccessRights.Add(System.Char)">
- <summary>
- Add the specified right.
- </summary>
- <remarks>
- Adds the right specified by the given character.
- </remarks>
- <returns><c>true</c> if the right was added; otherwise, <c>false</c>.</returns>
- <param name="right">The right.</param>
- </member>
- <member name="M:MailKit.AccessRights.AddRange(System.String)">
- <summary>
- Add the rights specified by the characters in the given string.
- </summary>
- <remarks>
- Adds the rights specified by the characters in the given string.
- </remarks>
- <param name="rights">The rights.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="rights"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.AccessRights.AddRange(System.Collections.Generic.IEnumerable{MailKit.AccessRight})">
- <summary>
- Add the range of specified rights.
- </summary>
- <remarks>
- Adds the range of specified rights.
- </remarks>
- <param name="rights">The rights.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="rights"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.AccessRights.Clear">
- <summary>
- Clears the access rights.
- </summary>
- <remarks>
- Removes all of the access rights.
- </remarks>
- </member>
- <member name="M:MailKit.AccessRights.Contains(MailKit.AccessRight)">
- <summary>
- Checks if the set of access rights contains the specified right.
- </summary>
- <remarks>
- Determines whether or not the set of access rights already contains the specified right
- </remarks>
- <returns><value>true</value> if the specified right exists; otherwise <value>false</value>.</returns>
- <param name="right">The access right.</param>
- </member>
- <member name="M:MailKit.AccessRights.CopyTo(MailKit.AccessRight[],System.Int32)">
- <summary>
- Copies all of the access rights to the specified array.
- </summary>
- <remarks>
- Copies all of the access rights into the array,
- starting at the specified array index.
- </remarks>
- <param name="array">The array.</param>
- <param name="arrayIndex">The array index.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="array"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="arrayIndex"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.AccessRights.Remove(MailKit.AccessRight)">
- <summary>
- Removes the specified access right.
- </summary>
- <remarks>
- Removes the specified access right.
- </remarks>
- <returns><value>true</value> if the access right was removed; otherwise <value>false</value>.</returns>
- <param name="right">The access right.</param>
- </member>
- <member name="P:MailKit.AccessRights.Item(System.Int32)">
- <summary>
- Get the access right at the specified index.
- </summary>
- <remarks>
- Gets the access right at the specified index.
- </remarks>
- <value>The access right at the specified index.</value>
- <param name="index">The index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.AccessRights.GetEnumerator">
- <summary>
- Get the access rights enumerator.
- </summary>
- <remarks>
- Gets the access rights enumerator.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.AccessRights.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Get the access rights enumerator.
- </summary>
- <remarks>
- Gets the access rights enumerator.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.AccessRights.ToString">
- <summary>
- Return a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRights"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRights"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRights"/>.</returns>
- </member>
- <member name="T:MailKit.AlertEventArgs">
- <summary>
- Alert event arguments.
- </summary>
- <remarks>
- Some <see cref="T:MailKit.IMailStore"/> implementations, such as
- <see cref="T:MailKit.Net.Imap.ImapClient"/>, will emit Alert
- events when they receive alert messages from the server.
- </remarks>
- </member>
- <member name="M:MailKit.AlertEventArgs.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AlertEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AlertEventArgs"/>.
- </remarks>
- <param name="message">The alert message.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.AlertEventArgs.Message">
- <summary>
- Gets the alert message.
- </summary>
- <remarks>
- The alert message will be the exact message received from the server.
- </remarks>
- <value>The alert message.</value>
- </member>
- <member name="T:MailKit.Annotation">
- <summary>
- An annotation.
- </summary>
- <remarks>
- <para>An annotation.</para>
- <para>For more information about annotations, see
- <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
- </remarks>
- </member>
- <member name="M:MailKit.Annotation.#ctor(MailKit.AnnotationEntry)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Annotation"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Annotation"/>.
- </remarks>
- <param name="entry">The annotation entry.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="entry"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.Annotation.Entry">
- <summary>
- Get the annotation tag.
- </summary>
- <remarks>
- Gets the annotation tag.
- </remarks>
- <value>The annotation tag.</value>
- </member>
- <member name="P:MailKit.Annotation.Properties">
- <summary>
- Get the annotation properties.
- </summary>
- <remarks>
- Gets the annotation properties.
- </remarks>
- </member>
- <member name="T:MailKit.AnnotationAccess">
- <summary>
- An annotation access level.
- </summary>
- <remarks>
- <para>An annotation access level.</para>
- <para>For more information about annotations, see
- <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAccess.None">
- <summary>
- Annotations are not supported.
- </summary>
- </member>
- <member name="F:MailKit.AnnotationAccess.ReadOnly">
- <summary>
- Annotations are read-only.
- </summary>
- </member>
- <member name="F:MailKit.AnnotationAccess.ReadWrite">
- <summary>
- Annotations are read-write.
- </summary>
- </member>
- <member name="T:MailKit.AnnotationAttribute">
- <summary>
- An annotation attribute.
- </summary>
- <remarks>
- <para>An annotation attribute.</para>
- <para>For more information about annotations, see
- <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAttribute.Value">
- <summary>
- The annotation value.
- </summary>
- <remarks>
- Used to get or set both the private and shared values of an annotation.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAttribute.SharedValue">
- <summary>
- The shared annotation value.
- </summary>
- <remarks>
- Used to get or set the shared value of an annotation.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAttribute.PrivateValue">
- <summary>
- The private annotation value.
- </summary>
- <remarks>
- Used to get or set the private value of an annotation.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAttribute.Size">
- <summary>
- The size of an annotation value.
- </summary>
- <remarks>
- Used to get the size of the both the private and shared annotation values.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAttribute.SharedSize">
- <summary>
- The size of a shared annotation value.
- </summary>
- <remarks>
- Used to get the size of a shared annotation value.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAttribute.PrivateSize">
- <summary>
- The size of a private annotation value.
- </summary>
- <remarks>
- Used to get the size of a private annotation value.
- </remarks>
- </member>
- <member name="M:MailKit.AnnotationAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AnnotationAttribute"/> class.
- </summary>
- <param name="specifier">The annotation attribute specifier.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="specifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="specifier"/> contains illegal characters.
- </exception>
- </member>
- <member name="P:MailKit.AnnotationAttribute.Name">
- <summary>
- Get the name of the annotation attribute.
- </summary>
- <remarks>
- Gets the name of the annotation attribute.
- </remarks>
- </member>
- <member name="P:MailKit.AnnotationAttribute.Scope">
- <summary>
- Get the scope of the annotation attribute.
- </summary>
- <remarks>
- Gets the scope of the annotation attribute.
- </remarks>
- </member>
- <member name="P:MailKit.AnnotationAttribute.Specifier">
- <summary>
- Get the annotation attribute specifier.
- </summary>
- <remarks>
- Gets the annotation attribute specifier.
- </remarks>
- </member>
- <member name="M:MailKit.AnnotationAttribute.Equals(MailKit.AnnotationAttribute)">
- <summary>
- Determines whether the specified <see cref="T:MailKit.AnnotationAttribute"/> is equal to the current <see cref="T:MailKit.AnnotationAttribute"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:MailKit.AnnotationAttribute"/> is equal to the current <see cref="T:MailKit.AnnotationAttribute"/>.
- </remarks>
- <param name="other">The <see cref="T:MailKit.AnnotationAttribute"/> to compare with the current <see cref="T:MailKit.AnnotationAttribute"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:MailKit.AnnotationAttribute"/> is equal to the current
- <see cref="T:MailKit.AnnotationAttribute"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.AnnotationAttribute.op_Equality(MailKit.AnnotationAttribute,MailKit.AnnotationAttribute)">
- <summary>
- Determines whether two annotation attributes are equal.
- </summary>
- <remarks>
- Determines whether two annotation attributes are equal.
- </remarks>
- <returns><c>true</c> if <paramref name="attr1"/> and <paramref name="attr2"/> are equal; otherwise, <c>false</c>.</returns>
- <param name="attr1">The first annotation attribute to compare.</param>
- <param name="attr2">The second annotation attribute to compare.</param>
- </member>
- <member name="M:MailKit.AnnotationAttribute.op_Inequality(MailKit.AnnotationAttribute,MailKit.AnnotationAttribute)">
- <summary>
- Determines whether two annotation attributes are not equal.
- </summary>
- <remarks>
- Determines whether two annotation attributes are not equal.
- </remarks>
- <returns><c>true</c> if <paramref name="attr1"/> and <paramref name="attr2"/> are not equal; otherwise, <c>false</c>.</returns>
- <param name="attr1">The first annotation attribute to compare.</param>
- <param name="attr2">The second annotation attribute to compare.</param>
- </member>
- <member name="M:MailKit.AnnotationAttribute.Equals(System.Object)">
- <summary>
- Determine whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AnnotationAttribute"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AnnotationAttribute"/>.
- </remarks>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.AnnotationAttribute"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current
- <see cref="T:MailKit.AnnotationAttribute"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.AnnotationAttribute.GetHashCode">
- <summary>
- Serves as a hash function for a <see cref="T:MailKit.AnnotationAttribute"/> object.
- </summary>
- <remarks>
- Serves as a hash function for a <see cref="T:MailKit.AnnotationAttribute"/> object.
- </remarks>
- <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
- </member>
- <member name="M:MailKit.AnnotationAttribute.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationAttribute"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationAttribute"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationAttribute"/>.</returns>
- </member>
- <member name="T:MailKit.AnnotationEntry">
- <summary>
- An annotation entry.
- </summary>
- <remarks>
- <para>An annotation entry.</para>
- <para>For more information about annotations, see
- <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.Comment">
- <summary>
- An annotation entry for a comment on a message.
- </summary>
- <remarks>
- Used to get or set a comment on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.PrivateComment">
- <summary>
- An annotation entry for a private comment on a message.
- </summary>
- <remarks>
- Used to get or set a private comment on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.SharedComment">
- <summary>
- An annotation entry for a shared comment on a message.
- </summary>
- <remarks>
- Used to get or set a shared comment on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.Flags">
- <summary>
- An annotation entry for flags on a message.
- </summary>
- <remarks>
- Used to get or set flags on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.PrivateFlags">
- <summary>
- An annotation entry for private flags on a message.
- </summary>
- <remarks>
- Used to get or set private flags on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.SharedFlags">
- <summary>
- Aa annotation entry for shared flags on a message.
- </summary>
- <remarks>
- Used to get or set shared flags on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.AltSubject">
- <summary>
- An annotation entry for an alternate subject on a message.
- </summary>
- <remarks>
- Used to get or set an alternate subject on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.PrivateAltSubject">
- <summary>
- An annotation entry for a private alternate subject on a message.
- </summary>
- <remarks>
- Used to get or set a private alternate subject on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.SharedAltSubject">
- <summary>
- An annotation entry for a shared alternate subject on a message.
- </summary>
- <remarks>
- Used to get or set a shared alternate subject on a message.
- </remarks>
- </member>
- <member name="M:MailKit.AnnotationEntry.#ctor(System.String,MailKit.AnnotationScope)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AnnotationEntry"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AnnotationEntry"/>.
- </remarks>
- <param name="path">The annotation entry path.</param>
- <param name="scope">The scope of the annotation.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="path"/> is invalid.
- </exception>
- </member>
- <member name="M:MailKit.AnnotationEntry.#ctor(System.String,System.String,MailKit.AnnotationScope)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AnnotationEntry"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AnnotationEntry"/> for an individual body part of a message.
- </remarks>
- <param name="partSpecifier">The part-specifier of the body part of the message.</param>
- <param name="path">The annotation entry path.</param>
- <param name="scope">The scope of the annotation.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="partSpecifier"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="path"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="partSpecifier"/> is invalid.</para>
- <para>-or-</para>
- <para><paramref name="path"/> is invalid.</para>
- </exception>
- </member>
- <member name="M:MailKit.AnnotationEntry.#ctor(MailKit.BodyPart,System.String,MailKit.AnnotationScope)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AnnotationEntry"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AnnotationEntry"/> for an individual body part of a message.
- </remarks>
- <param name="part">The body part of the message.</param>
- <param name="path">The annotation entry path.</param>
- <param name="scope">The scope of the annotation.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="part"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="path"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="path"/> is invalid.
- </exception>
- </member>
- <member name="P:MailKit.AnnotationEntry.Entry">
- <summary>
- Get the annotation entry specifier.
- </summary>
- <remarks>
- Gets the annotation entry specifier.
- </remarks>
- <value>The annotation entry specifier.</value>
- </member>
- <member name="P:MailKit.AnnotationEntry.PartSpecifier">
- <summary>
- Get the part-specifier component of the annotation entry.
- </summary>
- <remarks>
- Gets the part-specifier component of the annotation entry.
- </remarks>
- </member>
- <member name="P:MailKit.AnnotationEntry.Path">
- <summary>
- Get the path component of the annotation entry.
- </summary>
- <remarks>
- Gets the path component of the annotation entry.
- </remarks>
- </member>
- <member name="P:MailKit.AnnotationEntry.Scope">
- <summary>
- Get the scope of the annotation.
- </summary>
- <remarks>
- Gets the scope of the annotation.
- </remarks>
- </member>
- <member name="M:MailKit.AnnotationEntry.Equals(MailKit.AnnotationEntry)">
- <summary>
- Determines whether the specified <see cref="T:MailKit.AnnotationEntry"/> is equal to the current <see cref="T:MailKit.AnnotationEntry"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:MailKit.AnnotationEntry"/> is equal to the current <see cref="T:MailKit.AnnotationEntry"/>.
- </remarks>
- <param name="other">The <see cref="T:MailKit.AnnotationEntry"/> to compare with the current <see cref="T:MailKit.AnnotationEntry"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:MailKit.AnnotationEntry"/> is equal to the current
- <see cref="T:MailKit.AnnotationEntry"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.AnnotationEntry.op_Equality(MailKit.AnnotationEntry,MailKit.AnnotationEntry)">
- <summary>
- Determines whether two annotation entries are equal.
- </summary>
- <remarks>
- Determines whether two annotation entries are equal.
- </remarks>
- <returns><c>true</c> if <paramref name="entry1"/> and <paramref name="entry2"/> are equal; otherwise, <c>false</c>.</returns>
- <param name="entry1">The first annotation entry to compare.</param>
- <param name="entry2">The second annotation entry to compare.</param>
- </member>
- <member name="M:MailKit.AnnotationEntry.op_Inequality(MailKit.AnnotationEntry,MailKit.AnnotationEntry)">
- <summary>
- Determines whether two annotation entries are not equal.
- </summary>
- <remarks>
- Determines whether two annotation entries are not equal.
- </remarks>
- <returns><c>true</c> if <paramref name="entry1"/> and <paramref name="entry2"/> are not equal; otherwise, <c>false</c>.</returns>
- <param name="entry1">The first annotation entry to compare.</param>
- <param name="entry2">The second annotation entry to compare.</param>
- </member>
- <member name="M:MailKit.AnnotationEntry.Equals(System.Object)">
- <summary>
- Determine whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AnnotationEntry"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AnnotationEntry"/>.
- </remarks>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.AnnotationEntry"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current
- <see cref="T:MailKit.AnnotationEntry"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.AnnotationEntry.GetHashCode">
- <summary>
- Serves as a hash function for a <see cref="T:MailKit.AnnotationEntry"/> object.
- </summary>
- <remarks>
- Serves as a hash function for a <see cref="T:MailKit.AnnotationEntry"/> object.
- </remarks>
- <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
- </member>
- <member name="M:MailKit.AnnotationEntry.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationEntry"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationEntry"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationEntry"/>.</returns>
- </member>
- <member name="M:MailKit.AnnotationEntry.Parse(System.String)">
- <summary>
- Parse an annotation entry.
- </summary>
- <remarks>
- Parses an annotation entry.
- </remarks>
- <param name="entry">The annotation entry.</param>
- <returns>The parsed annotation entry.</returns>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="entry"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.FormatException">
- <paramref name="entry"/> does not conform to the annotation entry syntax.
- </exception>
- </member>
- <member name="T:MailKit.AnnotationsChangedEventArgs">
- <summary>
- Event args used when an annotation changes.
- </summary>
- <remarks>
- Event args used when an annotation changes.
- </remarks>
- </member>
- <member name="M:MailKit.AnnotationsChangedEventArgs.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AnnotationsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AnnotationsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- </member>
- <member name="M:MailKit.AnnotationsChangedEventArgs.#ctor(System.Int32,System.Collections.Generic.IEnumerable{MailKit.Annotation})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AnnotationsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AnnotationsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="annotations">The annotations that changed.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="annotations"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.AnnotationsChangedEventArgs.Annotations">
- <summary>
- Get the annotations that changed.
- </summary>
- <remarks>
- Gets the annotations that changed.
- </remarks>
- <value>The annotation.</value>
- </member>
- <member name="P:MailKit.AnnotationsChangedEventArgs.ModSeq">
- <summary>
- Gets the updated mod-sequence value of the message, if available.
- </summary>
- <remarks>
- Gets the updated mod-sequence value of the message, if available.
- </remarks>
- <value>The mod-sequence value.</value>
- </member>
- <member name="T:MailKit.AnnotationScope">
- <summary>
- The scope of an annotation.
- </summary>
- <remarks>
- <para>Represents the scope of an annotation.</para>
- <para>For more information about annotations, see
- <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationScope.None">
- <summary>
- No scopes.
- </summary>
- </member>
- <member name="F:MailKit.AnnotationScope.Private">
- <summary>
- The private annotation scope.
- </summary>
- </member>
- <member name="F:MailKit.AnnotationScope.Shared">
- <summary>
- The shared annotation scope.
- </summary>
- </member>
- <member name="F:MailKit.AnnotationScope.Both">
- <summary>
- Both private and shared scopes.
- </summary>
- </member>
- <member name="T:MailKit.AuthenticatedEventArgs">
- <summary>
- Authenticated event arguments.
- </summary>
- <remarks>
- Some servers, such as GMail IMAP, will send some free-form text in
- the response to a successful login.
- </remarks>
- </member>
- <member name="M:MailKit.AuthenticatedEventArgs.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AuthenticatedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AuthenticatedEventArgs"/>.
- </remarks>
- <param name="message">The free-form text.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.AuthenticatedEventArgs.Message">
- <summary>
- Get the free-form text sent by the server.
- </summary>
- <remarks>
- Gets the free-form text sent by the server.
- </remarks>
- <value>The free-form text sent by the server.</value>
- </member>
- <member name="T:MailKit.BodyPart">
- <summary>
- An abstract body part of a message.
- </summary>
- <remarks>
- Each body part will actually be a <see cref="T:MailKit.BodyPartBasic"/>,
- <see cref="T:MailKit.BodyPartText"/>, <see cref="T:MailKit.BodyPartMessage"/>, or
- <see cref="T:MailKit.BodyPartMultipart"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- </member>
- <member name="M:MailKit.BodyPart.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.BodyPart"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.BodyPart"/>.
- </remarks>
- </member>
- <member name="P:MailKit.BodyPart.ContentType">
- <summary>
- Gets the Content-Type of the body part.
- </summary>
- <remarks>
- Gets the Content-Type of the body part.
- </remarks>
- <value>The content type.</value>
- </member>
- <member name="P:MailKit.BodyPart.PartSpecifier">
- <summary>
- Gets the part specifier.
- </summary>
- <remarks>
- Gets the part specifier.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <value>The part specifier.</value>
- </member>
- <member name="M:MailKit.BodyPart.Accept(MailKit.BodyPartVisitor)">
- <summary>
- Dispatches to the specific visit method for this MIME body part.
- </summary>
- <remarks>
- This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
- calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
- method to call into a more specific method on a derived visitor class
- of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
- support unknown visitors by calling
- <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
- </remarks>
- <param name="visitor">The visitor.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="visitor"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPart.Encode(System.Text.StringBuilder)">
- <summary>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <remarks>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </remarks>
- <param name="builder">The string builder.</param>
- </member>
- <member name="M:MailKit.BodyPart.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.BodyPart"/>.
- </summary>
- <remarks>
- <para>Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.BodyPart"/>.</para>
- <note type="note">The syntax of the string returned, while similar to IMAP's BODYSTRUCTURE syntax,
- is not completely compatible.</note>
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.BodyPart"/>.</returns>
- </member>
- <member name="M:MailKit.BodyPart.TryParse(System.String,MailKit.BodyPart@)">
- <summary>
- Tries to parse the given text into a new <see cref="T:MailKit.BodyPart"/> instance.
- </summary>
- <remarks>
- <para>Parses a body part from the specified text.</para>
- <note type="note">This syntax, while similar to IMAP's BODYSTRUCTURE syntax, is not completely
- compatible.</note>
- </remarks>
- <returns><c>true</c>, if the body part was successfully parsed, <c>false</c> otherwise.</returns>
- <param name="text">The text to parse.</param>
- <param name="part">The parsed body part.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.BodyPartBasic">
- <summary>
- A basic message body part.
- </summary>
- <remarks>
- Represents any message body part that is not a multipart,
- message/rfc822 part, or a text part.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- </member>
- <member name="M:MailKit.BodyPartBasic.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.BodyPartBasic"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.BodyPartBasic"/>.
- </remarks>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentId">
- <summary>
- Gets the Content-Id of the body part, if available.
- </summary>
- <remarks>
- Gets the Content-Id of the body part, if available.
- </remarks>
- <value>The content identifier.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentDescription">
- <summary>
- Gets the Content-Description of the body part, if available.
- </summary>
- <remarks>
- Gets the Content-Description of the body part, if available.
- </remarks>
- <value>The content description.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentTransferEncoding">
- <summary>
- Gets the Content-Transfer-Encoding of the body part.
- </summary>
- <remarks>
- <para>Gets the Content-Transfer-Encoding of the body part.</para>
- <para>Hint: Use the <a href="M_MimeKit_Utils_MimeUtils_TryParse_1.htm">MimeUtils.TryParse</a>
- method to parse this value into a usable <see cref="T:MimeKit.ContentEncoding"/>.</para>
- </remarks>
- <value>The content transfer encoding.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.Octets">
- <summary>
- Gets the size of the body part, in bytes.
- </summary>
- <remarks>
- Gets the size of the body part, in bytes.
- </remarks>
- <value>The number of octets.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentMd5">
- <summary>
- Gets the MD5 hash of the content, if available.
- </summary>
- <remarks>
- Gets the MD5 hash of the content, if available.
- </remarks>
- <value>The content md5.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentDisposition">
- <summary>
- Gets the Content-Disposition of the body part, if available.
- </summary>
- <remarks>
- <para>Gets the Content-Disposition of the body part, if available.</para>
- <note type="note">The Content-Disposition value is only retrieved if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is used when fetching
- summary information from an <see cref="T:MailKit.IMailFolder"/>.</note>
- </remarks>
- <value>The content disposition.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentLanguage">
- <summary>
- Gets the Content-Language of the body part, if available.
- </summary>
- <remarks>
- <para>Gets the Content-Language of the body part, if available.</para>
- <para>The Content-Language value is only retrieved if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is used when fetching
- summary information from an <see cref="T:MailKit.IMailFolder"/>.</para>
- </remarks>
- <value>The content language.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentLocation">
- <summary>
- Gets the Content-Location of the body part, if available.
- </summary>
- <remarks>
- <para>Gets the Content-Location of the body part, if available.</para>
- <para>The Content-Location value is only retrieved if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is used when fetching
- summary information from an <see cref="T:MailKit.IMailFolder"/>.</para>
- </remarks>
- <value>The content location.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.IsAttachment">
- <summary>
- Determines whether or not the body part is an attachment.
- </summary>
- <remarks>
- <para>Determines whether or not the body part is an attachment based on the value of
- the Content-Disposition.</para>
- <note type="note">Since the value of the Content-Disposition header is needed, it
- is necessary to include the <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag when
- fetching summary information from an <see cref="T:MailKit.IMailFolder"/>.</note>
- </remarks>
- <value><c>true</c> if this part is an attachment; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.FileName">
- <summary>
- Get the name of the file.
- </summary>
- <remarks>
- <para>First checks for the "filename" parameter on the Content-Disposition header. If
- that does not exist, then the "name" parameter on the Content-Type header is used.</para>
- <note type="note">Since the value of the Content-Disposition header is needed, it is
- necessary to include the <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag when
- fetching summary information from an <see cref="T:MailKit.IMailFolder"/>.</note>
- </remarks>
- <value>The name of the file.</value>
- </member>
- <member name="M:MailKit.BodyPartBasic.Accept(MailKit.BodyPartVisitor)">
- <summary>
- Dispatches to the specific visit method for this MIME body part.
- </summary>
- <remarks>
- This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
- calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
- method to call into a more specific method on a derived visitor class
- of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
- support unknown visitors by calling
- <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
- </remarks>
- <param name="visitor">The visitor.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="visitor"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartBasic.Encode(System.Text.StringBuilder)">
- <summary>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <remarks>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </remarks>
- <param name="builder">The string builder.</param>
- </member>
- <member name="T:MailKit.BodyPartCollection">
- <summary>
- A <see cref="T:MailKit.BodyPart"/> collection.
- </summary>
- <remarks>
- A <see cref="T:MailKit.BodyPart"/> collection.
- </remarks>
- </member>
- <member name="M:MailKit.BodyPartCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.BodyPartCollection"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.BodyPartCollection"/>.
- </remarks>
- </member>
- <member name="P:MailKit.BodyPartCollection.Count">
- <summary>
- Get the number of body parts in the collection.
- </summary>
- <remarks>
- Gets the number of body parts in the collection.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="P:MailKit.BodyPartCollection.IsReadOnly">
- <summary>
- Get whether or not this body part collection is read only.
- </summary>
- <remarks>
- Gets whether or not this body part collection is read only.
- </remarks>
- <value><c>true</c> if this collection is read only; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.BodyPartCollection.Add(MailKit.BodyPart)">
- <summary>
- Add the specified body part to the collection.
- </summary>
- <remarks>
- Adds the specified body part to the collection.
- </remarks>
- <param name="part">The body part.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartCollection.Clear">
- <summary>
- Clears the body part collection.
- </summary>
- <remarks>
- Removes all of the body parts from the collection.
- </remarks>
- </member>
- <member name="M:MailKit.BodyPartCollection.Contains(MailKit.BodyPart)">
- <summary>
- Checks if the collection contains the specified body part.
- </summary>
- <remarks>
- Determines whether or not the collection contains the specified body part.
- </remarks>
- <returns><value>true</value> if the specified body part exists; otherwise <value>false</value>.</returns>
- <param name="part">The body part.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartCollection.CopyTo(MailKit.BodyPart[],System.Int32)">
- <summary>
- Copies all of the body parts in the collection to the specified array.
- </summary>
- <remarks>
- Copies all of the body parts within the collection into the array,
- starting at the specified array index.
- </remarks>
- <param name="array">The array.</param>
- <param name="arrayIndex">The array index.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="array"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="arrayIndex"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartCollection.Remove(MailKit.BodyPart)">
- <summary>
- Removes the specified body part.
- </summary>
- <remarks>
- Removes the specified body part.
- </remarks>
- <returns><value>true</value> if the body part was removed; otherwise <value>false</value>.</returns>
- <param name="part">The body part.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.BodyPartCollection.Item(System.Int32)">
- <summary>
- Get the body part at the specified index.
- </summary>
- <remarks>
- Gets the body part at the specified index.
- </remarks>
- <value>The body part at the specified index.</value>
- <param name="index">The index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartCollection.IndexOf(System.Uri)">
- <summary>
- Gets the index of the body part matching the specified URI.
- </summary>
- <remarks>
- <para>Finds the index of the body part matching the specified URI, if it exists.</para>
- <para>If the URI scheme is <c>"cid"</c>, then matching is performed based on the Content-Id header
- values, otherwise the Content-Location headers are used. If the provided URI is absolute and a child
- part's Content-Location is relative, then then the child part's Content-Location URI will be combined
- with the value of its Content-Base header, if available, otherwise it will be combined with the
- multipart/related part's Content-Base header in order to produce an absolute URI that can be
- compared with the provided absolute URI.</para>
- </remarks>
- <returns>The index of the part matching the specified URI if found; otherwise <c>-1</c>.</returns>
- <param name="uri">The URI of the body part.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uri"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartCollection.GetEnumerator">
- <summary>
- Get the body part enumerator.
- </summary>
- <remarks>
- Gets the body part enumerator.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.BodyPartCollection.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Get the body part enumerator.
- </summary>
- <remarks>
- Gets the body part enumerator.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="T:MailKit.BodyPartMessage">
- <summary>
- A message/rfc822 body part.
- </summary>
- <remarks>
- Represents a message/rfc822 body part.
- </remarks>
- </member>
- <member name="M:MailKit.BodyPartMessage.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.BodyPartMessage"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.BodyPartMessage"/>.
- </remarks>
- </member>
- <member name="P:MailKit.BodyPartMessage.Envelope">
- <summary>
- Gets the envelope of the message, if available.
- </summary>
- <remarks>
- Gets the envelope of the message, if available.
- </remarks>
- <value>The envelope.</value>
- </member>
- <member name="P:MailKit.BodyPartMessage.Body">
- <summary>
- Gets the body structure of the message.
- </summary>
- <remarks>
- Gets the body structure of the message.
- </remarks>
- <value>The body structure.</value>
- </member>
- <member name="P:MailKit.BodyPartMessage.Lines">
- <summary>
- Gets the length of the message, in lines.
- </summary>
- <remarks>
- Gets the length of the message, in lines.
- </remarks>
- <value>The number of lines.</value>
- </member>
- <member name="M:MailKit.BodyPartMessage.Accept(MailKit.BodyPartVisitor)">
- <summary>
- Dispatches to the specific visit method for this MIME body part.
- </summary>
- <remarks>
- This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
- calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
- method to call into a more specific method on a derived visitor class
- of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
- support unknown visitors by calling
- <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
- </remarks>
- <param name="visitor">The visitor.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="visitor"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartMessage.Encode(System.Text.StringBuilder)">
- <summary>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <remarks>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </remarks>
- <param name="builder">The string builder.</param>
- </member>
- <member name="T:MailKit.BodyPartMultipart">
- <summary>
- A multipart body part.
- </summary>
- <remarks>
- A multipart body part.
- </remarks>
- </member>
- <member name="M:MailKit.BodyPartMultipart.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.BodyPartMultipart"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.BodyPartMultipart"/>.
- </remarks>
- </member>
- <member name="P:MailKit.BodyPartMultipart.BodyParts">
- <summary>
- Gets the child body parts.
- </summary>
- <remarks>
- Gets the child body parts.
- </remarks>
- <value>The child body parts.</value>
- </member>
- <member name="P:MailKit.BodyPartMultipart.ContentDisposition">
- <summary>
- Gets the Content-Disposition of the body part, if available.
- </summary>
- <remarks>
- Gets the Content-Disposition of the body part, if available.
- </remarks>
- <value>The content disposition.</value>
- </member>
- <member name="P:MailKit.BodyPartMultipart.ContentLanguage">
- <summary>
- Gets the Content-Language of the body part, if available.
- </summary>
- <remarks>
- Gets the Content-Language of the body part, if available.
- </remarks>
- <value>The content language.</value>
- </member>
- <member name="P:MailKit.BodyPartMultipart.ContentLocation">
- <summary>
- Gets the Content-Location of the body part, if available.
- </summary>
- <remarks>
- Gets the Content-Location of the body part, if available.
- </remarks>
- <value>The content location.</value>
- </member>
- <member name="M:MailKit.BodyPartMultipart.Accept(MailKit.BodyPartVisitor)">
- <summary>
- Dispatches to the specific visit method for this MIME body part.
- </summary>
- <remarks>
- This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
- calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
- method to call into a more specific method on a derived visitor class
- of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
- support unknown visitors by calling
- <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
- </remarks>
- <param name="visitor">The visitor.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="visitor"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartMultipart.Encode(System.Text.StringBuilder)">
- <summary>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <remarks>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </remarks>
- <param name="builder">The string builder.</param>
- </member>
- <member name="T:MailKit.BodyPartText">
- <summary>
- A textual body part.
- </summary>
- <remarks>
- Represents any body part with a media type of "text".
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- </member>
- <member name="M:MailKit.BodyPartText.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.BodyPartText"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.BodyPartText"/>.
- </remarks>
- </member>
- <member name="P:MailKit.BodyPartText.IsPlain">
- <summary>
- Gets whether or not this text part contains plain text.
- </summary>
- <remarks>
- Checks whether or not the text part's Content-Type is text/plain.
- </remarks>
- <value><c>true</c> if the text is html; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.BodyPartText.IsHtml">
- <summary>
- Gets whether or not this text part contains HTML.
- </summary>
- <remarks>
- Checks whether or not the text part's Content-Type is text/html.
- </remarks>
- <value><c>true</c> if the text is html; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.BodyPartText.Lines">
- <summary>
- Gets the length of the text, in lines.
- </summary>
- <remarks>
- Gets the length of the text, in lines.
- </remarks>
- <value>The number of lines.</value>
- </member>
- <member name="M:MailKit.BodyPartText.Accept(MailKit.BodyPartVisitor)">
- <summary>
- Dispatches to the specific visit method for this MIME body part.
- </summary>
- <remarks>
- This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
- calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
- method to call into a more specific method on a derived visitor class
- of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
- support unknown visitors by calling
- <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
- </remarks>
- <param name="visitor">The visitor.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="visitor"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartText.Encode(System.Text.StringBuilder)">
- <summary>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <remarks>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </remarks>
- <param name="builder">The string builder.</param>
- </member>
- <member name="T:MailKit.BodyPartVisitor">
- <summary>
- Represents a visitor for a tree of MIME body parts.
- </summary>
- <remarks>
- This class is designed to be inherited to create more specialized classes whose
- functionality requires traversing, examining or copying a tree of MIME body parts.
- </remarks>
- </member>
- <member name="M:MailKit.BodyPartVisitor.Visit(MailKit.BodyPart)">
- <summary>
- Dispatches the entity to one of the more specialized visit methods in this class.
- </summary>
- <remarks>
- Dispatches the entity to one of the more specialized visit methods in this class.
- </remarks>
- <param name="body">The MIME body part.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)">
- <summary>
- Visit the abstract MIME body part.
- </summary>
- <remarks>
- Visits the abstract MIME body part.
- </remarks>
- <param name="entity">The MIME body part.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitBodyPartBasic(MailKit.BodyPartBasic)">
- <summary>
- Visit the basic MIME body part.
- </summary>
- <remarks>
- Visits the basic MIME body part.
- </remarks>
- <param name="entity">The basic MIME body part.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitMessage(MailKit.BodyPart)">
- <summary>
- Visit the message contained within a message/rfc822 or message/news MIME entity.
- </summary>
- <remarks>
- Visits the message contained within a message/rfc822 or message/news MIME entity.
- </remarks>
- <param name="message">The body part representing the message/rfc822 message.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitBodyPartMessage(MailKit.BodyPartMessage)">
- <summary>
- Visit the message/rfc822 or message/news MIME entity.
- </summary>
- <remarks>
- Visits the message/rfc822 or message/news MIME entity.
- </remarks>
- <param name="entity">The message/rfc822 or message/news body part.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitChildren(MailKit.BodyPartMultipart)">
- <summary>
- Visit the children of a <see cref="T:MailKit.BodyPartMultipart"/>.
- </summary>
- <remarks>
- Visits the children of a <see cref="T:MailKit.BodyPartMultipart"/>.
- </remarks>
- <param name="multipart">The multipart.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitBodyPartMultipart(MailKit.BodyPartMultipart)">
- <summary>
- Visit the abstract multipart MIME entity.
- </summary>
- <remarks>
- Visits the abstract multipart MIME entity.
- </remarks>
- <param name="multipart">The multipart body part.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitBodyPartText(MailKit.BodyPartText)">
- <summary>
- Visit the text-based MIME part entity.
- </summary>
- <remarks>
- Visits the text-based MIME part entity.
- </remarks>
- <param name="entity">The text-based body part.</param>
- </member>
- <member name="T:MailKit.CommandException">
- <summary>
- The exception that is thrown when there is a command error.
- </summary>
- <remarks>
- A <see cref="T:MailKit.CommandException"/> can be thrown by any of the various client
- methods in MailKit. Unlike a <see cref="T:MailKit.ProtocolException"/>, a
- <see cref="T:MailKit.CommandException"/> is typically non-fatal (meaning that it does
- not force the client to disconnect).
- </remarks>
- </member>
- <member name="M:MailKit.CommandException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.CommandException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.CommandException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.CommandException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.CommandException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.CommandException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.CommandException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.CommandException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.CompressedStream">
- <summary>
- A compressed stream.
- </summary>
- </member>
- <member name="P:MailKit.CompressedStream.InnerStream">
- <summary>
- Gets the inner stream.
- </summary>
- <value>The inner stream.</value>
- </member>
- <member name="P:MailKit.CompressedStream.CanRead">
- <summary>
- Gets whether the stream supports reading.
- </summary>
- <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.CompressedStream.CanWrite">
- <summary>
- Gets whether the stream supports writing.
- </summary>
- <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.CompressedStream.CanSeek">
- <summary>
- Gets whether the stream supports seeking.
- </summary>
- <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.CompressedStream.CanTimeout">
- <summary>
- Gets whether the stream supports I/O timeouts.
- </summary>
- <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.CompressedStream.ReadTimeout">
- <summary>
- Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
- </summary>
- <returns>A value, in miliseconds, that determines how long the stream will attempt to read before timing out.</returns>
- <value>The read timeout.</value>
- </member>
- <member name="P:MailKit.CompressedStream.WriteTimeout">
- <summary>
- Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
- </summary>
- <returns>A value, in miliseconds, that determines how long the stream will attempt to write before timing out.</returns>
- <value>The write timeout.</value>
- </member>
- <member name="P:MailKit.CompressedStream.Position">
- <summary>
- Gets or sets the position within the current stream.
- </summary>
- <returns>The current position within the stream.</returns>
- <value>The position of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="P:MailKit.CompressedStream.Length">
- <summary>
- Gets the length in bytes of the stream.
- </summary>
- <returns>A long value representing the length of the stream in bytes.</returns>
- <value>The length of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <param name="buffer">The buffer to write.</param>
- <param name="offset">The offset of the first byte to write.</param>
- <param name="count">The number of bytes to write.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <returns>A task that represents the asynchronous write operation.</returns>
- <param name="buffer">The buffer to write.</param>
- <param name="offset">The offset of the first byte to write.</param>
- <param name="count">The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.Flush">
- <summary>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.FlushAsync(System.Threading.CancellationToken)">
- <summary>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <returns>A task that represents the asynchronous flush operation.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- Sets the position within the current stream.
- </summary>
- <returns>The new position within the stream.</returns>
- <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
- <param name="origin">The origin to seek from.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.SetLength(System.Int64)">
- <summary>
- Sets the length of the stream.
- </summary>
- <param name="value">The desired length of the stream in bytes.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support setting the length.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.CompressedStream"/> and
- optionally releases the managed resources.
- </summary>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.ConnectedEventArgs">
- <summary>
- Connected event arguments.
- </summary>
- <remarks>
- When a <see cref="T:MailKit.IMailService"/> is connected, it will emit a
- <see cref="E:MailKit.IMailService.Connected"/> event.
- </remarks>
- </member>
- <member name="M:MailKit.ConnectedEventArgs.#ctor(System.String,System.Int32,MailKit.Security.SecureSocketOptions)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ConnectedEventArgs"/> class.
- </summary>
- <param name="host">The name of the host that the client connected to.</param>
- <param name="port">The port that the client connected to on the remote host.</param>
- <param name="options">The SSL/TLS options that were used when connecting to the remote host.</param>
- </member>
- <member name="P:MailKit.ConnectedEventArgs.Host">
- <summary>
- Get the name of the remote host.
- </summary>
- <remarks>
- Gets the name of the remote host.
- </remarks>
- <value>The host name of the server.</value>
- </member>
- <member name="P:MailKit.ConnectedEventArgs.Port">
- <summary>
- Get the port.
- </summary>
- <remarks>
- Gets the port.
- </remarks>
- <value>The port.</value>
- </member>
- <member name="P:MailKit.ConnectedEventArgs.Options">
- <summary>
- Get the SSL/TLS options.
- </summary>
- <remarks>
- Gets the SSL/TLS options.
- </remarks>
- <value>The SSL/TLS options.</value>
- </member>
- <member name="T:MailKit.DeliveryStatusNotification">
- <summary>
- Delivery status notification types.
- </summary>
- <remarks>
- A set of flags that may be bitwise-or'd together to specify
- when a delivery status notification should be sent for a
- particlar recipient.
- </remarks>
- </member>
- <member name="F:MailKit.DeliveryStatusNotification.Never">
- <summary>
- Never send delivery status notifications.
- </summary>
- </member>
- <member name="F:MailKit.DeliveryStatusNotification.Success">
- <summary>
- Send a notification on successful delivery to the recipient.
- </summary>
- </member>
- <member name="F:MailKit.DeliveryStatusNotification.Failure">
- <summary>
- Send a notification on failure to deliver to the recipient.
- </summary>
- </member>
- <member name="F:MailKit.DeliveryStatusNotification.Delay">
- <summary>
- Send a notification when the delivery to the recipient has
- been delayed for an unusual amount of time.
- </summary>
- </member>
- <member name="T:MailKit.DisconnectedEventArgs">
- <summary>
- Disconnected event arguments.
- </summary>
- <remarks>
- When a <see cref="T:MailKit.IMailService"/> gets disconnected, it will emit a
- <see cref="E:MailKit.IMailService.Disconnected"/> event.
- </remarks>
- </member>
- <member name="M:MailKit.DisconnectedEventArgs.#ctor(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.DisconnectedEventArgs"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.DisconnectedEventArgs"/> class.
- </remarks>
- <param name="host">The name of the host that the client was connected to.</param>
- <param name="port">The port that the client was connected to.</param>
- <param name="options">The SSL/TLS options that were used by the client.</param>
- <param name="requested">If <c>true</c>, the <see cref="T:MailKit.IMailService"/> was disconnected via the
- <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> method.</param>
- </member>
- <member name="P:MailKit.DisconnectedEventArgs.IsRequested">
- <summary>
- Get whether or not the service was explicitly asked to disconnect.
- </summary>
- <remarks>
- If the <see cref="T:MailKit.IMailService"/> was disconnected via the
- <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> method, then
- the value of <see cref="P:MailKit.DisconnectedEventArgs.IsRequested"/> will be <c>true</c>. If the connection was unexpectedly
- dropped, then the value will be <c>false</c>.
- </remarks>
- <value><c>true</c> if the disconnect was explicitly requested; otherwise, <c>false</c>.</value>
- </member>
- <member name="T:MailKit.DuplexStream">
- <summary>
- A duplex stream.
- </summary>
- </member>
- <member name="M:MailKit.DuplexStream.#ctor(System.IO.Stream,System.IO.Stream)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.DuplexStream"/> class.
- </summary>
- <param name="istream">The stream to use for input.</param>
- <param name="ostream">The stream to use for output.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="istream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="ostream"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.DuplexStream.InputStream">
- <summary>
- Gets the input stream.
- </summary>
- <value>The input stream.</value>
- </member>
- <member name="P:MailKit.DuplexStream.OutputStream">
- <summary>
- Gets the output stream.
- </summary>
- <value>The output stream.</value>
- </member>
- <member name="P:MailKit.DuplexStream.CanRead">
- <summary>
- Gets whether the stream supports reading.
- </summary>
- <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.DuplexStream.CanWrite">
- <summary>
- Gets whether the stream supports writing.
- </summary>
- <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.DuplexStream.CanSeek">
- <summary>
- Gets whether the stream supports seeking.
- </summary>
- <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.DuplexStream.CanTimeout">
- <summary>
- Gets whether the stream supports I/O timeouts.
- </summary>
- <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.DuplexStream.ReadTimeout">
- <summary>
- Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
- </summary>
- <returns>A value, in miliseconds, that determines how long the stream will attempt to read before timing out.</returns>
- <value>The read timeout.</value>
- </member>
- <member name="P:MailKit.DuplexStream.WriteTimeout">
- <summary>
- Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
- </summary>
- <returns>A value, in miliseconds, that determines how long the stream will attempt to write before timing out.</returns>
- <value>The write timeout.</value>
- </member>
- <member name="P:MailKit.DuplexStream.Position">
- <summary>
- Gets or sets the position within the current stream.
- </summary>
- <returns>The current position within the stream.</returns>
- <value>The position of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="P:MailKit.DuplexStream.Length">
- <summary>
- Gets the length in bytes of the stream.
- </summary>
- <returns>A long value representing the length of the stream in bytes.</returns>
- <value>The length of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <param name="buffer">The buffer to write.</param>
- <param name="offset">The offset of the first byte to write.</param>
- <param name="count">The number of bytes to write.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <returns>A task that represents the asynchronous write operation.</returns>
- <param name="buffer">The buffer to write.</param>
- <param name="offset">The offset of the first byte to write.</param>
- <param name="count">The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.Flush">
- <summary>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.FlushAsync(System.Threading.CancellationToken)">
- <summary>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <returns>A task that represents the asynchronous flush operation.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- Sets the position within the current stream.
- </summary>
- <returns>The new position within the stream.</returns>
- <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
- <param name="origin">The origin to seek from.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.SetLength(System.Int64)">
- <summary>
- Sets the length of the stream.
- </summary>
- <param name="value">The desired length of the stream in bytes.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support setting the length.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.DuplexStream"/> and
- optionally releases the managed resources.
- </summary>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Envelope">
- <summary>
- A message envelope containing a brief summary of the message.
- </summary>
- <remarks>
- The envelope of a message contains information such as the
- date the message was sent, the subject of the message,
- the sender of the message, who the message was sent to,
- which message(s) the message may be in reply to,
- and the message id.
- </remarks>
- </member>
- <member name="M:MailKit.Envelope.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Envelope"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Envelope"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Envelope.From">
- <summary>
- Gets the address(es) that the message is from.
- </summary>
- <remarks>
- Gets the address(es) that the message is from.
- </remarks>
- <value>The address(es) that the message is from.</value>
- </member>
- <member name="P:MailKit.Envelope.Sender">
- <summary>
- Gets the actual sender(s) of the message.
- </summary>
- <remarks>
- The senders may differ from the addresses in <see cref="P:MailKit.Envelope.From"/> if
- the message was sent by someone on behalf of someone else.
- </remarks>
- <value>The actual sender(s) of the message.</value>
- </member>
- <member name="P:MailKit.Envelope.ReplyTo">
- <summary>
- Gets the address(es) that replies should be sent to.
- </summary>
- <remarks>
- The senders of the message may prefer that replies are sent
- somewhere other than the address they used to send the message.
- </remarks>
- <value>The address(es) that replies should be sent to.</value>
- </member>
- <member name="P:MailKit.Envelope.To">
- <summary>
- Gets the list of addresses that the message was sent to.
- </summary>
- <remarks>
- Gets the list of addresses that the message was sent to.
- </remarks>
- <value>The address(es) that the message was sent to.</value>
- </member>
- <member name="P:MailKit.Envelope.Cc">
- <summary>
- Gets the list of addresses that the message was carbon-copied to.
- </summary>
- <remarks>
- Gets the list of addresses that the message was carbon-copied to.
- </remarks>
- <value>The address(es) that the message was carbon-copied to.</value>
- </member>
- <member name="P:MailKit.Envelope.Bcc">
- <summary>
- Gets the list of addresses that the message was blind-carbon-copied to.
- </summary>
- <remarks>
- Gets the list of addresses that the message was blind-carbon-copied to.
- </remarks>
- <value>The address(es) that the message was carbon-copied to.</value>
- </member>
- <member name="P:MailKit.Envelope.InReplyTo">
- <summary>
- The Message-Id that the message is replying to.
- </summary>
- <remarks>
- The Message-Id that the message is replying to.
- </remarks>
- <value>The Message-Id that the message is replying to.</value>
- </member>
- <member name="P:MailKit.Envelope.Date">
- <summary>
- Gets the date that the message was sent on, if available.
- </summary>
- <remarks>
- Gets the date that the message was sent on, if available.
- </remarks>
- <value>The date the message was sent.</value>
- </member>
- <member name="P:MailKit.Envelope.MessageId">
- <summary>
- Gets the ID of the message, if available.
- </summary>
- <remarks>
- Gets the ID of the message, if available.
- </remarks>
- <value>The message identifier.</value>
- </member>
- <member name="P:MailKit.Envelope.Subject">
- <summary>
- Gets the subject of the message.
- </summary>
- <remarks>
- Gets the subject of the message.
- </remarks>
- <value>The subject.</value>
- </member>
- <member name="M:MailKit.Envelope.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.Envelope"/>.
- </summary>
- <remarks>
- <para>The returned string can be parsed by <see cref="M:MailKit.Envelope.TryParse(System.String,MailKit.Envelope@)"/>.</para>
- <note type="warning">The syntax of the string returned, while similar to IMAP's ENVELOPE syntax,
- is not completely compatible.</note>
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.Envelope"/>.</returns>
- </member>
- <member name="M:MailKit.Envelope.TryParse(System.String,MailKit.Envelope@)">
- <summary>
- Tries to parse the given text into a new <see cref="T:MailKit.Envelope"/> instance.
- </summary>
- <remarks>
- <para>Parses an Envelope value from the specified text.</para>
- <note type="warning">This syntax, while similar to IMAP's ENVELOPE syntax, is not
- completely compatible.</note>
- </remarks>
- <returns><c>true</c>, if the envelope was successfully parsed, <c>false</c> otherwise.</returns>
- <param name="text">The text to parse.</param>
- <param name="envelope">The parsed envelope.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.FolderAccess">
- <summary>
- A folder access mode.
- </summary>
- <remarks>
- A folder access mode.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- </member>
- <member name="F:MailKit.FolderAccess.None">
- <summary>
- The folder is not open.
- </summary>
- </member>
- <member name="F:MailKit.FolderAccess.ReadOnly">
- <summary>
- The folder is read-only.
- </summary>
- </member>
- <member name="F:MailKit.FolderAccess.ReadWrite">
- <summary>
- The folder is read/write.
- </summary>
- </member>
- <member name="T:MailKit.FolderAttributes">
- <summary>
- Folder attributes as used by <see cref="P:MailKit.IMailFolder.Attributes"/>.
- </summary>
- <remarks>
- Folder attributes as used by <see cref="P:MailKit.IMailFolder.Attributes"/>.
- </remarks>
- </member>
- <member name="F:MailKit.FolderAttributes.None">
- <summary>
- The folder does not have any attributes.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.NoInferiors">
- <summary>
- It is not possible for any subfolders to exist under the folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.NoSelect">
- <summary>
- It is not possible to select the folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Marked">
- <summary>
- The folder has been marked as possibly containing new messages
- since the folder was last selected.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Unmarked">
- <summary>
- The folder does not contain any new messages since the folder
- was last selected.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.NonExistent">
- <summary>
- The folder does not exist, but is simply a place-holder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Subscribed">
- <summary>
- The folder is subscribed.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Remote">
- <summary>
- The folder is remote.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.HasChildren">
- <summary>
- The folder has subfolders.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.HasNoChildren">
- <summary>
- The folder does not have any subfolders.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.All">
- <summary>
- The folder is a special "All" folder containing an aggregate of all messages.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Archive">
- <summary>
- The folder is a special "Archive" folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Drafts">
- <summary>
- The folder is the special "Drafts" folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Flagged">
- <summary>
- The folder is the special "Flagged" folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Inbox">
- <summary>
- The folder is the special "Inbox" folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Junk">
- <summary>
- The folder is the special "Junk" folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Sent">
- <summary>
- The folder is the special "Sent" folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Trash">
- <summary>
- The folder is the special "Trash" folder.
- </summary>
- </member>
- <member name="T:MailKit.FolderCreatedEventArgs">
- <summary>
- Event args used when a <see cref="T:MailKit.IMailFolder"/> is created.
- </summary>
- <remarks>
- Event args used when a <see cref="T:MailKit.IMailFolder"/> is created.
- </remarks>
- </member>
- <member name="M:MailKit.FolderCreatedEventArgs.#ctor(MailKit.IMailFolder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderCreatedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderCreatedEventArgs"/>.
- </remarks>
- <param name="folder">The newly created folder.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folder"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.FolderCreatedEventArgs.Folder">
- <summary>
- Get the folder that was just created.
- </summary>
- <remarks>
- Gets the folder that was just created.
- </remarks>
- <value>The folder.</value>
- </member>
- <member name="T:MailKit.FolderNamespace">
- <summary>
- A folder namespace.
- </summary>
- <remarks>
- A folder namespace.
- </remarks>
- </member>
- <member name="F:MailKit.FolderNamespace.DirectorySeparator">
- <summary>
- The directory separator for this folder namespace.
- </summary>
- <remarks>
- The directory separator for this folder namespace.
- </remarks>
- </member>
- <member name="F:MailKit.FolderNamespace.Path">
- <summary>
- The base path for this folder namespace.
- </summary>
- <remarks>
- The base path for this folder namespace.
- </remarks>
- </member>
- <member name="M:MailKit.FolderNamespace.#ctor(System.Char,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNamespace"/> class.
- </summary>
- <remarks>
- Creates a new folder namespace.
- </remarks>
- <param name="directorySeparator">The directory separator.</param>
- <param name="path">The folder path.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.FolderNamespaceCollection">
- <summary>
- A read-only collection of folder namespaces.
- </summary>
- <remarks>
- A read-only collection of folder namespaces.
- </remarks>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNamespaceCollection"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNamespaceCollection"/>.
- </remarks>
- </member>
- <member name="P:MailKit.FolderNamespaceCollection.Count">
- <summary>
- Gets the number of folder namespaces contained in the collection.
- </summary>
- <remarks>
- Gets the number of folder namespaces contained in the collection.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.Add(MailKit.FolderNamespace)">
- <summary>
- Adds the specified namespace.
- </summary>
- <remarks>
- Adds the specified namespace.
- </remarks>
- <param name="namespace">The namespace to add.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.Clear">
- <summary>
- Removes all namespaces from the collection.
- </summary>
- <remarks>
- Removes all namespaces from the collection.
- </remarks>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.Contains(MailKit.FolderNamespace)">
- <summary>
- Checks if the collection contains the specified namespace.
- </summary>
- <remarks>
- Checks if the collection contains the specified namespace.
- </remarks>
- <returns><value>true</value> if the specified namespace exists;
- otherwise <value>false</value>.</returns>
- <param name="namespace">The namespace.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.Remove(MailKit.FolderNamespace)">
- <summary>
- Removes the first occurance of the specified namespace.
- </summary>
- <remarks>
- Removes the first occurance of the specified namespace.
- </remarks>
- <returns><value>true</value> if the frst occurance of the specified
- namespace was removed; otherwise <value>false</value>.</returns>
- <param name="namespace">The namespace.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.FolderNamespaceCollection.Item(System.Int32)">
- <summary>
- Gets the <see cref="T:MailKit.FolderNamespace"/> at the specified index.
- </summary>
- <remarks>
- Gets the <see cref="T:MailKit.FolderNamespace"/> at the specified index.
- </remarks>
- <value>The folder namespace at the specified index.</value>
- <param name="index">The index.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="value"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.GetEnumerator">
- <summary>
- Gets the enumerator.
- </summary>
- <remarks>
- Gets the enumerator.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Gets the enumerator.
- </summary>
- <remarks>
- Gets the enumerator.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.FolderNamespaceCollection"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.FolderNamespaceCollection"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.FolderNamespaceCollection"/>.</returns>
- </member>
- <member name="T:MailKit.FolderNotFoundException">
- <summary>
- The exception that is thrown when a folder could not be found.
- </summary>
- <remarks>
- This exception is thrown by <see cref="M:MailKit.IMailFolder.GetSubfolder(System.String,System.Threading.CancellationToken)"/>.
- </remarks>
- </member>
- <member name="M:MailKit.FolderNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotFoundException"/> class.
- </summary>
- <remarks>
- Deserializes a <see cref="T:MailKit.FolderNotFoundException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNotFoundException.#ctor(System.String,System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotFoundException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNotFoundException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="folderName">The name of the folder.</param>
- <param name="innerException">The inner exception.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folderName"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNotFoundException.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotFoundException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNotFoundException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="folderName">The name of the folder.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folderName"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNotFoundException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotFoundException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNotFoundException"/>.
- </remarks>
- <param name="folderName">The name of the folder.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folderName"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.FolderNotFoundException.FolderName">
- <summary>
- Gets the name of the folder that could not be found.
- </summary>
- <remarks>
- Gets the name of the folder that could not be found.
- </remarks>
- <value>The name of the folder.</value>
- </member>
- <member name="M:MailKit.FolderNotFoundException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
- with information about the exception.
- </summary>
- <remarks>
- Serializes the state of the <see cref="T:MailKit.FolderNotFoundException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.FolderNotOpenException">
- <summary>
- The exception that is thrown when a folder is not open.
- </summary>
- <remarks>
- This exception is thrown when an operation on a folder could not be completed
- due to the folder being in a closed state. For example, the
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>
- method will throw a <see cref="T:MailKit.FolderNotOpenException"/> if the folder is not
- current open.
- </remarks>
- </member>
- <member name="M:MailKit.FolderNotOpenException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotOpenException"/> class.
- </summary>
- <remarks>
- Deserializes a <see cref="T:MailKit.FolderNotOpenException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNotOpenException.#ctor(System.String,MailKit.FolderAccess,System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotOpenException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNotOpenException"/>.
- </remarks>
- <param name="folderName">The folder name.</param>
- <param name="access">The minimum folder access required by the operation.</param>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folderName"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNotOpenException.#ctor(System.String,MailKit.FolderAccess,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotOpenException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNotOpenException"/>.
- </remarks>
- <param name="folderName">The folder name.</param>
- <param name="access">The minimum folder access required by the operation.</param>
- <param name="message">The error message.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folderName"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNotOpenException.#ctor(System.String,MailKit.FolderAccess)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotOpenException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNotOpenException"/>.
- </remarks>
- <param name="folderName">The folder name.</param>
- <param name="access">The minimum folder access required by the operation.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folderName"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.FolderNotOpenException.FolderName">
- <summary>
- Get the name of the folder.
- </summary>
- <remarks>
- Gets the name of the folder.
- </remarks>
- <value>The name of the folder.</value>
- </member>
- <member name="P:MailKit.FolderNotOpenException.FolderAccess">
- <summary>
- Get the minimum folder access required by the operation.
- </summary>
- <remarks>
- Gets the minimum folder access required by the operation.
- </remarks>
- <value>The minimum required folder access.</value>
- </member>
- <member name="M:MailKit.FolderNotOpenException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
- with information about the exception.
- </summary>
- <remarks>
- Serializes the state of the <see cref="T:MailKit.FolderNotOpenException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.FolderQuota">
- <summary>
- A folder quota.
- </summary>
- <remarks>
- A <see cref="T:MailKit.FolderQuota"/> is returned by <see cref="M:MailKit.IMailFolder.GetQuota(System.Threading.CancellationToken)"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="M:MailKit.FolderQuota.#ctor(MailKit.IMailFolder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderQuota"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderQuota"/> with the specified root.
- </remarks>
- <param name="quotaRoot">The quota root.</param>
- </member>
- <member name="P:MailKit.FolderQuota.QuotaRoot">
- <summary>
- Get the quota root.
- </summary>
- <remarks>
- Gets the quota root. If the quota root is <c>null</c>, then
- it suggests that the folder does not have a quota.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The quota root.</value>
- </member>
- <member name="P:MailKit.FolderQuota.MessageLimit">
- <summary>
- Get or set the message limit.
- </summary>
- <remarks>
- Gets or sets the message limit.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The message limit.</value>
- </member>
- <member name="P:MailKit.FolderQuota.StorageLimit">
- <summary>
- Get or set the storage limit, in kilobytes.
- </summary>
- <remarks>
- Gets or sets the storage limit, in kilobytes.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The storage limit, in kilobytes.</value>
- </member>
- <member name="P:MailKit.FolderQuota.CurrentMessageCount">
- <summary>
- Get or set the current message count.
- </summary>
- <remarks>
- Gets or sets the current message count.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The current message count.</value>
- </member>
- <member name="P:MailKit.FolderQuota.CurrentStorageSize">
- <summary>
- Gets or sets the size of the current storage, in kilobytes.
- </summary>
- <remarks>
- Gets or sets the size of the current storage, in kilobytes.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The size of the current storage, in kilobytes.</value>
- </member>
- <member name="T:MailKit.FolderRenamedEventArgs">
- <summary>
- Event args used when a <see cref="T:MailKit.IMailFolder"/> is renamed.
- </summary>
- <remarks>
- Event args used when a <see cref="T:MailKit.IMailFolder"/> is renamed.
- </remarks>
- </member>
- <member name="M:MailKit.FolderRenamedEventArgs.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderRenamedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderRenamedEventArgs"/>.
- </remarks>
- <param name="oldName">The old name of the folder.</param>
- <param name="newName">The new name of the folder.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="oldName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="newName"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.FolderRenamedEventArgs.OldName">
- <summary>
- The old name of the folder.
- </summary>
- <remarks>
- The old name of the folder.
- </remarks>
- <value>The old name.</value>
- </member>
- <member name="P:MailKit.FolderRenamedEventArgs.NewName">
- <summary>
- The new name of the folder.
- </summary>
- <remarks>
- The new name of the folder.
- </remarks>
- <value>The new name.</value>
- </member>
- <member name="T:MailKit.IMailFolder">
- <summary>
- An interface for a mailbox folder as used by <see cref="T:MailKit.IMailStore"/>.
- </summary>
- <remarks>
- Implemented by message stores such as <see cref="T:MailKit.Net.Imap.ImapClient"/>
- </remarks>
- </member>
- <member name="P:MailKit.IMailFolder.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the folder.
- </summary>
- <remarks>
- Gets an object that can be used to synchronize access to the folder.
- </remarks>
- <value>The sync root.</value>
- </member>
- <member name="P:MailKit.IMailFolder.ParentFolder">
- <summary>
- Get the parent folder.
- </summary>
- <remarks>
- Root-level folders do not have a parent folder.
- </remarks>
- <value>The parent folder.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Attributes">
- <summary>
- Get the folder attributes.
- </summary>
- <remarks>
- Gets the folder attributes.
- </remarks>
- <value>The folder attributes.</value>
- </member>
- <member name="P:MailKit.IMailFolder.AnnotationAccess">
- <summary>
- Get the annotation access level.
- </summary>
- <remarks>
- If annotations are supported, this property can be used to determine whether or not
- the <see cref="T:MailKit.IMailFolder"/> supports reading and writing annotations.
- </remarks>
- </member>
- <member name="P:MailKit.IMailFolder.AnnotationScopes">
- <summary>
- Get the supported annotation scopes.
- </summary>
- <remarks>
- If annotations are supported, this property can be used to determine which
- annotation scopes are supported by the <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="P:MailKit.IMailFolder.MaxAnnotationSize">
- <summary>
- Get the maximum size of annotation values supported by the folder.
- </summary>
- <remarks>
- If annotations are supported, this property can be used to determine the
- maximum size of annotation values supported by the <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="P:MailKit.IMailFolder.PermanentFlags">
- <summary>
- Get the permanent flags.
- </summary>
- <remarks>
- <para>The permanent flags are the message flags that will persist between sessions.</para>
- <para>If the <see cref="F:MailKit.MessageFlags.UserDefined"/> flag is set, then the folder allows
- storing of user-defined (custom) message flags.</para>
- </remarks>
- <value>The permanent flags.</value>
- </member>
- <member name="P:MailKit.IMailFolder.AcceptedFlags">
- <summary>
- Get the accepted flags.
- </summary>
- <remarks>
- The accepted flags are the message flags that will be accepted and persist
- for the current session. For the set of flags that will persist between
- sessions, see the <see cref="P:MailKit.IMailFolder.PermanentFlags"/> property.
- </remarks>
- <value>The accepted flags.</value>
- </member>
- <member name="P:MailKit.IMailFolder.DirectorySeparator">
- <summary>
- Get the directory separator.
- </summary>
- <remarks>
- Gets the directory separator.
- </remarks>
- <value>The directory separator.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Access">
- <summary>
- Get the read/write access of the folder.
- </summary>
- <remarks>
- Gets the read/write access of the folder.
- </remarks>
- <value>The read/write access.</value>
- </member>
- <member name="P:MailKit.IMailFolder.IsNamespace">
- <summary>
- Get whether or not the folder is a namespace folder.
- </summary>
- <remarks>
- Gets whether or not the folder is a namespace folder.
- </remarks>
- <value><c>true</c> if the folder is a namespace folder; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailFolder.FullName">
- <summary>
- Get the full name of the folder.
- </summary>
- <remarks>
- This is the equivalent of the full path of a file on a file system.
- </remarks>
- <value>The full name of the folder.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Name">
- <summary>
- Get the name of the folder.
- </summary>
- <remarks>
- This is the equivalent of the file name of a file on the file system.
- </remarks>
- <value>The name of the folder.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Id">
- <summary>
- Get the unique identifier for the folder, if available.
- </summary>
- <remarks>
- <para>Gets a unique identifier for the folder, if available. This is useful for clients
- implementing a message cache that want to track the folder after it is renamed by another
- client.</para>
- <note type="note">This property will only be available if the server supports the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The unique folder identifier.</value>
- </member>
- <member name="P:MailKit.IMailFolder.IsSubscribed">
- <summary>
- Get whether or not the folder is subscribed.
- </summary>
- <remarks>
- Gets whether or not the folder is subscribed.
- </remarks>
- <value><c>true</c> if the folder is subscribed; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailFolder.IsOpen">
- <summary>
- Get whether or not the folder is currently open.
- </summary>
- <remarks>
- Gets whether or not the folder is currently open.
- </remarks>
- <value><c>true</c> if the folder is currently open; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Exists">
- <summary>
- Get whether or not the folder exists.
- </summary>
- <remarks>
- Gets whether or not the folder exists.
- </remarks>
- <value><c>true</c> if the folder exists; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailFolder.SupportsModSeq">
- <summary>
- Get whether or not the folder supports mod-sequences.
- </summary>
- <remarks>
- If mod-sequences are not supported by the folder, then all of the APIs that take a modseq
- argument will throw <see cref="T:System.NotSupportedException"/> and should not be used.
- </remarks>
- <value><c>true</c> if supports mod-sequences; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailFolder.HighestModSeq">
- <summary>
- Get the highest mod-sequence value of all messages in the mailbox.
- </summary>
- <remarks>
- Gets the highest mod-sequence value of all messages in the mailbox.
- </remarks>
- <value>The highest mod-sequence value.</value>
- </member>
- <member name="P:MailKit.IMailFolder.UidValidity">
- <summary>
- Get the Unique ID validity.
- </summary>
- <remarks>
- <para>UIDs are only valid so long as the UID validity value remains unchanged. If and when
- the folder's <see cref="P:MailKit.IMailFolder.UidValidity"/> is changed, a client MUST discard its cache of UIDs
- along with any summary information that it may have and re-query the folder.</para>
- <para>The <see cref="P:MailKit.IMailFolder.UidValidity"/> will only be set after the folder has been opened.</para>
- </remarks>
- <value>The UID validity.</value>
- </member>
- <member name="P:MailKit.IMailFolder.UidNext">
- <summary>
- Get the UID that the next message that is added to the folder will be assigned.
- </summary>
- <remarks>
- This value will only be set after the folder has been opened.
- </remarks>
- <value>The next UID.</value>
- </member>
- <member name="P:MailKit.IMailFolder.AppendLimit">
- <summary>
- Get the maximum size of a message that can be appended to the folder.
- </summary>
- <remarks>
- <para>Gets the maximum size of a message that can be appended to the folder.</para>
- <note type="note">If the value is not set, then the limit is unspecified.</note>
- </remarks>
- <value>The append limit.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Size">
- <summary>
- Get the size of the folder.
- </summary>
- <remarks>
- <para>Gets the size of the folder in bytes.</para>
- <note type="note">If the value is not set, then the size is unspecified.</note>
- </remarks>
- <value>The size.</value>
- </member>
- <member name="P:MailKit.IMailFolder.FirstUnread">
- <summary>
- Get the index of the first unread message in the folder.
- </summary>
- <remarks>
- This value will only be set after the folder has been opened.
- </remarks>
- <value>The index of the first unread message.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Unread">
- <summary>
- Get the number of unread messages in the folder.
- </summary>
- <remarks>
- <para>Gets the number of unread messages in the folder.</para>
- <note type="note">This value will only be set after calling
- <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- with <see cref="F:MailKit.StatusItems.Unread"/>.</note>
- </remarks>
- <value>The number of unread messages.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Recent">
- <summary>
- Get the number of recently delivered messages in the folder.
- </summary>
- <remarks>
- <para>Gets the number of recently delivered messages in the folder.</para>
- <note type="note">
- This value will only be set after calling
- <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- with <see cref="F:MailKit.StatusItems.Recent"/>.</note>
- </remarks>
- <value>The number of recently delivered messages.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Count">
- <summary>
- Get the total number of messages in the folder.
- </summary>
- <remarks>
- Gets the total number of messages in the folder.
- </remarks>
- <value>The total number of messages.</value>
- </member>
- <member name="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Opens the folder using the requested folder access.
- </summary>
- <remarks>
- <para>This variant of the <see cref="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- method is meant for quick resynchronization of the folder. Before calling this method,
- the <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
- <para>You should also make sure to add listeners to the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> and
- <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events to get notifications of changes since
- the last time the folder was opened.</para>
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="uidValidity">The last known <see cref="P:MailKit.IMailFolder.UidValidity"/> value.</param>
- <param name="highestModSeq">The last known <see cref="P:MailKit.IMailFolder.HighestModSeq"/> value.</param>
- <param name="uids">The last known list of unique message identifiers.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.OpenAsync(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously opens the folder using the requested folder access.
- </summary>
- <remarks>
- <para>This variant of the <see cref="M:MailKit.IMailFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- method is meant for quick resynchronization of the folder. Before calling this method,
- the <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
- <para>You should also make sure to add listeners to the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> and
- <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events to get notifications of changes since
- the last time the folder was opened.</para>
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="uidValidity">The last known <see cref="P:MailKit.IMailFolder.UidValidity"/> value.</param>
- <param name="highestModSeq">The last known <see cref="P:MailKit.IMailFolder.HighestModSeq"/> value.</param>
- <param name="uids">The last known list of unique message identifiers.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)">
- <summary>
- Open the folder using the requested folder access.
- </summary>
- <remarks>
- Opens the folder using the requested folder access.
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)">
- <summary>
- Asynchronously open the folder using the requested folder access.
- </summary>
- <remarks>
- Asynchronously opens the folder using the requested folder access.
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Close(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Close the folder, optionally expunging the messages marked for deletion.
- </summary>
- <remarks>
- Closes the folder, optionally expunging the messages marked for deletion.
- </remarks>
- <param name="expunge">If set to <c>true</c>, expunge.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CloseAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously close the folder, optionally expunging the messages marked for deletion.
- </summary>
- <remarks>
- Asynchronously closes the folder, optionally expunging the messages marked for deletion.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="expunge">If set to <c>true</c>, expunge.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Create(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CreateAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Asynchronously creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Create(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUses">A list of special uses for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CreateAsync(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Asynchronously creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUses">A list of special uses for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Create(System.String,MailKit.SpecialFolder,System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUse">The special use for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CreateAsync(System.String,MailKit.SpecialFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Asynchronously creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUse">The special use for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Rename(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
- <summary>
- Rename the folder.
- </summary>
- <remarks>
- Renames the folder.
- </remarks>
- <param name="parent">The new parent folder.</param>
- <param name="name">The new name of the folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RenameAsync(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously rename the folder.
- </summary>
- <remarks>
- Asynchronously renames the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="parent">The new parent folder.</param>
- <param name="name">The new name of the folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Delete(System.Threading.CancellationToken)">
- <summary>
- Delete the folder.
- </summary>
- <remarks>
- Deletes the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.DeleteAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously delete the folder.
- </summary>
- <remarks>
- Asynchronously deletes the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Subscribe(System.Threading.CancellationToken)">
- <summary>
- Subscribe to the folder.
- </summary>
- <remarks>
- Subscribes to the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SubscribeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously subscribe to the folder.
- </summary>
- <remarks>
- Asynchronously subscribes to the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Unsubscribe(System.Threading.CancellationToken)">
- <summary>
- Unsubscribe from the folder.
- </summary>
- <remarks>
- Unsubscribes from the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.UnsubscribeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously unsubscribe from the folder.
- </summary>
- <remarks>
- Asynchronously unsubscribes from the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetSubfolders(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get the subfolders.
- </summary>
- <remarks>
- <para>Gets the subfolders as well as queries the server for the status of the requested items.</para>
- <para>When the <paramref name="items"/> argument is non-empty, this has the equivalent functionality
- of calling <see cref="M:MailKit.IMailFolder.GetSubfolders(System.Boolean,System.Threading.CancellationToken)"/> and then calling
- <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> on each of the returned folders.</para>
- <note type="tip">Using this method is potentially more efficient than querying the status of each returned folder.</note>
- </remarks>
- <returns>The subfolders.</returns>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetSubfoldersAsync(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the subfolders.
- </summary>
- <remarks>
- <para>Asynchronously gets the subfolders as well as queries the server for the status of the requested items.</para>
- <para>When the <paramref name="items"/> argument is non-empty, this has the equivalent functionality
- of calling <see cref="M:MailKit.IMailFolder.GetSubfoldersAsync(System.Boolean,System.Threading.CancellationToken)"/> and then calling
- <see cref="M:MailKit.IMailFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)"/> on each of the returned folders.</para>
- </remarks>
- <returns>The subfolders.</returns>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetSubfolders(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get the subfolders.
- </summary>
- <remarks>
- Gets the subfolders.
- </remarks>
- <returns>The subfolders.</returns>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetSubfoldersAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the subfolders.
- </summary>
- <remarks>
- Asynchronously gets the subfolders.
- </remarks>
- <returns>The subfolders.</returns>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetSubfolder(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the specified subfolder.
- </summary>
- <remarks>
- Gets the specified subfolder.
- </remarks>
- <returns>The subfolder.</returns>
- <param name="name">The name of the subfolder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetSubfolderAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the specified subfolder.
- </summary>
- <remarks>
- Asynchronously gets the specified subfolder.
- </remarks>
- <returns>The subfolder.</returns>
- <param name="name">The name of the subfolder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Check(System.Threading.CancellationToken)">
- <summary>
- Force the server to flush its state for the folder.
- </summary>
- <remarks>
- Forces the server to flush its state for the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CheckAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously force the server to flush its state for the folder.
- </summary>
- <remarks>
- Asynchronously forces the server to flush its state for the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)">
- <summary>
- Update the values of the specified items.
- </summary>
- <remarks>
- <para>Updates the values of the specified items.</para>
- <para>The <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
- MUST NOT be used on a folder that is already in the opened state. Instead, other ways
- of getting the desired information should be used.</para>
- <para>For example, a common use for the <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- method is to get the number of unread messages in the folder. When the folder is open, however, it is
- possible to use the <see cref="M:MailKit.IMailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
- method to query for the list of unread messages.</para>
- </remarks>
- <param name="items">The items to update.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously update the values of the specified items.
- </summary>
- <remarks>
- <para>Updates the values of the specified items.</para>
- <para>The <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
- MUST NOT be used on a folder that is already in the opened state. Instead, other ways
- of getting the desired information should be used.</para>
- <para>For example, a common use for the <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- method is to get the number of unread messages in the folder. When the folder is open, however, it is
- possible to use the <see cref="M:MailKit.IMailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
- method to query for the list of unread messages.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="items">The items to update.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetAccessControlList(System.Threading.CancellationToken)">
- <summary>
- Get the complete access control list for the folder.
- </summary>
- <remarks>
- Gets the complete access control list for the folder.
- </remarks>
- <returns>The access control list.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetAccessControlListAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the complete access control list for the folder.
- </summary>
- <remarks>
- Asynchronously gets the complete access control list for the folder.
- </remarks>
- <returns>The access control list.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetAccessRights(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the access rights for a particular identifier.
- </summary>
- <remarks>
- Gets the access rights for a particular identifier.
- </remarks>
- <returns>The access rights.</returns>
- <param name="name">The identifier name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetAccessRightsAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for a particular identifier.
- </summary>
- <remarks>
- Asynchronously gets the access rights for a particular identifier.
- </remarks>
- <returns>The access rights.</returns>
- <param name="name">The identifier name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMyAccessRights(System.Threading.CancellationToken)">
- <summary>
- Get the access rights for the current authenticated user.
- </summary>
- <remarks>
- Gets the access rights for the current authenticated user.
- </remarks>
- <returns>The access rights.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMyAccessRightsAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for the current authenticated user.
- </summary>
- <remarks>
- Asynchronously gets the access rights for the current authenticated user.
- </remarks>
- <returns>The access rights.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Add access rights for the specified identity.
- </summary>
- <remarks>
- Adds the given access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add access rights for the specified identity.
- </summary>
- <remarks>
- Asynchronously adds the given access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Remove access rights for the specified identity.
- </summary>
- <remarks>
- Removes the given access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove access rights for the specified identity.
- </summary>
- <remarks>
- Asynchronously removes the given access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Set the access rights for the specified identity.
- </summary>
- <remarks>
- Sets the access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the access rights for the sepcified identity.
- </summary>
- <remarks>
- Asynchronously sets the access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveAccess(System.String,System.Threading.CancellationToken)">
- <summary>
- Remove all access rights for the given identity.
- </summary>
- <remarks>
- Removes all access rights for the given identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveAccessAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove all access rights for the given identity.
- </summary>
- <remarks>
- Asynchronously removes all access rights for the given identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetQuota(System.Threading.CancellationToken)">
- <summary>
- Get the quota information for the folder.
- </summary>
- <remarks>
- <para>Gets the quota information for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetQuotaAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the quota information for the folder.
- </summary>
- <remarks>
- <para>Asynchronously gets the quota information for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetQuota(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
- <summary>
- Set the quota limits for the folder.
- </summary>
- <remarks>
- <para>Sets the quota limits for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The updated folder quota.</returns>
- <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
- <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetQuotaAsync(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the quota limits for the folder.
- </summary>
- <remarks>
- <para>Asynchronously sets the quota limits for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The updated folder quota.</returns>
- <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
- <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMetadata(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMetadataAsync(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Sets the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the specified metadata.
- </summary>
- <remarks>
- Asynchronously sets the specified metadata.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Expunge(System.Threading.CancellationToken)">
- <summary>
- Expunge the folder, permanently removing all messages marked for deletion.
- </summary>
- <remarks>
- <para>Expunges the folder, permanently removing all messages marked for deletion.</para>
- <note type="note">Normally, an <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event will be emitted for each
- message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.ExpungeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously expunge the folder, permanently removing all messages marked for deletion.
- </summary>
- <remarks>
- <para>Asynchronously expunges the folder, permanently removing all messages marked for deletion.</para>
- <note type="note">Normally, an <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Expunge the specified uids, permanently removing them from the folder.
- </summary>
- <remarks>
- <para>Expunges the specified uids, permanently removing them from the folder.</para>
- <note type="note">Normally, an <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <param name="uids">The message uids.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.ExpungeAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously expunge the specified uids, permanently removing them from the folder.
- </summary>
- <remarks>
- <para>Asynchronously expunges the specified uids, permanently removing them from the folder.</para>
- <note type="note">Normally, an <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The message uids.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyTo(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified message to the destination folder.
- </summary>
- <remarks>
- Copies the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyToAsync(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveTo(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified message to the destination folder.
- </summary>
- <remarks>
- Moves the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveToAsync(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified messages to the destination folder.
- </summary>
- <remarks>
- Moves the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyTo(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified message to the destination folder.
- </summary>
- <remarks>
- Copies the specified message to the destination folder.
- </remarks>
- <param name="index">The index of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyToAsync(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified message to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The indexes of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <param name="indexes">The indexes of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified messages to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveTo(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified message to the destination folder.
- </summary>
- <remarks>
- Moves the specified message to the destination folder.
- </remarks>
- <param name="index">The index of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveToAsync(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified message to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified messages to the destination folder.
- </summary>
- <remarks>
- Moves the specified messages to the destination folder.
- </remarks>
- <param name="indexes">The indexes of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified messages to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes that have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes that have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes that have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes
- (inclusive) that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes (inclusive) that have a higher mod-sequence value than the
- one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes
- (inclusive) that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes (inclusive) that have a higher mod-sequence value than the
- one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes
- (inclusive) that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes (inclusive) that have a higher mod-sequence value than the
- one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeaders(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeadersAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message headers.
- </summary>
- <remarks>
- Asynchronously gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeaders(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeadersAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Asynchronously gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeaders(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeadersAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message headers.
- </summary>
- <remarks>
- Asynchronously gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeaders(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeadersAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Asynchronously gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMessageAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message.
- </summary>
- <remarks>
- Asynchronously gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message.
- </summary>
- <remarks>
- Asynchronously gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetBodyPart(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetBodyPartAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Asynchronously gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetBodyPart(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetBodyPartAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Asynchronously gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- Gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- Asynchronously gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- Gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- Asynchronously gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(MailKit.UniqueId,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified body part.
- </summary>
- <remarks>
- Gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(MailKit.UniqueId,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified body part.
- </summary>
- <remarks>
- Asynchronously gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(System.Int32,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified body part.
- </summary>
- <remarks>
- Gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(System.Int32,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified body part.
- </summary>
- <remarks>
- Asynchronously gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message. If the starting
- offset is beyond the end of the specified section of the message, an empty stream
- is returned. If the number of bytes desired extends beyond the end of the section,
- a truncated stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message. If the starting
- offset is beyond the end of the specified section of the message, an empty stream
- is returned. If the number of bytes desired extends beyond the end of the section,
- a truncated stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UIDs of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UIDs of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified message.
- </summary>
- <remarks>
- Adds a set of labels to the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UIDs of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified message.
- </summary>
- <remarks>
- Removes a set of labels from the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified message.
- </summary>
- <remarks>
- Sets the labels of the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified message.
- </summary>
- <remarks>
- Adds a set of labels to the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified message.
- </summary>
- <remarks>
- Removes a set of labels from the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified message.
- </summary>
- <remarks>
- Sets the labels of the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Store(MailKit.UniqueId,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified message.
- </summary>
- <remarks>
- Stores the annotations for the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StoreAsync(MailKit.UniqueId,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified message.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages.
- </summary>
- <remarks>
- Stores the annotations for the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Store(System.Int32,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified message.
- </summary>
- <remarks>
- Stores the annotations for the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StoreAsync(System.Int32,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified message.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The indexes of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Store(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages.
- </summary>
- <remarks>
- Stores the annotations for the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Store(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.s
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SearchAsync(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Search(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SearchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Search(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SearchAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Search(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- Searches the fsubset of UIDs in the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SearchAsync(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the fsubset of UIDs in the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SortAsync(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Sort(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SortAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SortAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SortAsync(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the folder for messages matching the specified query,
- returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Thread(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.ThreadAsync(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Thread(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.ThreadAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="E:MailKit.IMailFolder.Opened">
- <summary>
- Occurs when the folder is opened.
- </summary>
- <remarks>
- Emitted when the folder is opened.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.Closed">
- <summary>
- Occurs when the folder is closed.
- </summary>
- <remarks>
- Emitted when the folder is closed.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.Deleted">
- <summary>
- Occurs when the folder is deleted.
- </summary>
- <remarks>
- Emitted when the folder is deleted.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.Renamed">
- <summary>
- Occurs when the folder is renamed.
- </summary>
- <remarks>
- Emitted when the folder is renamed.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.Subscribed">
- <summary>
- Occurs when the folder is subscribed.
- </summary>
- <remarks>
- Emitted when the folder is subscribed.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.Unsubscribed">
- <summary>
- Occurs when the folder is unsubscribed.
- </summary>
- <remarks>
- Emitted when the folder is unsubscribed.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.MessageExpunged">
- <summary>
- Occurs when a message is expunged from the folder.
- </summary>
- <remarks>
- Emitted when a message is expunged from the folder.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- </member>
- <member name="E:MailKit.IMailFolder.MessagesVanished">
- <summary>
- Occurs when messages vanish from the folder.
- </summary>
- <remarks>
- Emitted when a messages vanish from the folder.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.MessageFlagsChanged">
- <summary>
- Occurs when flags changed on a message.
- </summary>
- <remarks>
- Emitted when flags changed on a message.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- </member>
- <member name="E:MailKit.IMailFolder.MessageLabelsChanged">
- <summary>
- Occurs when labels changed on a message.
- </summary>
- <remarks>
- Emitted when labels changed on a message.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.AnnotationsChanged">
- <summary>
- Occurs when annotations changed on a message.
- </summary>
- <remarks>
- Emitted when annotations changed on a message.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.MessageSummaryFetched">
- <summary>
- Occurs when a message summary is fetched from the folder.
- </summary>
- <remarks>
- <para>Emitted when a message summary is fetched from the folder.</para>
- <para>When multiple message summaries are being fetched from a remote folder,
- it is possible that the connection will drop or some other exception will
- occur, causing the Fetch method to fail, requiring the client to request the
- same set of message summaries again after it reconnects. This is obviously
- inefficient. To alleviate this potential problem, this event will be emitted
- as soon as the <see cref="T:MailKit.IMailFolder"/> successfully retrieves the complete
- <see cref="T:MailKit.IMessageSummary"/> for each requested message.</para>
- <note type="note">The <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- methods will return a list of all message summaries that any information was
- retrieved for, regardless of whether or not all of the requested items were fetched,
- therefore there may be a discrepency between the number of times this event is
- emitetd and the number of summary items returned from the Fetch method.</note>
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.MetadataChanged">
- <summary>
- Occurs when metadata changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailFolder.MetadataChanged"/> event is emitted when metadata changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.ModSeqChanged">
- <summary>
- Occurs when the mod-sequence changed on a message.
- </summary>
- <remarks>
- Emitted when the mod-sequence changed on a message.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.HighestModSeqChanged">
- <summary>
- Occurs when the highest mod-sequence changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailFolder.HighestModSeqChanged"/> event is emitted whenever the <see cref="P:MailKit.IMailFolder.HighestModSeq"/> value changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.UidNextChanged">
- <summary>
- Occurs when the next UID changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.UidNext"/> property changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.UidValidityChanged">
- <summary>
- Occurs when the UID validity changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.UidValidity"/> property changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.IdChanged">
- <summary>
- Occurs when the ID changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.Id"/> property changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.SizeChanged">
- <summary>
- Occurs when the size of the folder changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.Size"/> property changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.CountChanged">
- <summary>
- Occurs when the message count changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.Count"/> property changes.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- </member>
- <member name="E:MailKit.IMailFolder.RecentChanged">
- <summary>
- Occurs when the recent message count changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.Recent"/> property changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.UnreadChanged">
- <summary>
- Occurs when the message unread count changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.Unread"/> property changes.
- </remarks>
- </member>
- <member name="T:MailKit.IMailService">
- <summary>
- An interface for message services such as SMTP, POP3, or IMAP.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Smtp.SmtpClient"/>
- and <see cref="T:MailKit.Net.Pop3.Pop3Client"/>.
- </remarks>
- </member>
- <member name="P:MailKit.IMailService.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the folder.
- </summary>
- <remarks>
- Gets an object that can be used to synchronize access to the folder.
- </remarks>
- <value>The sync root.</value>
- </member>
- <member name="P:MailKit.IMailService.SslProtocols">
- <summary>
- Gets or sets the SSL and TLS protocol versions that the client is allowed to use.
- </summary>
- <remarks>
- <para>Gets or sets the SSL and TLS protocol versions that the client is allowed to use.</para>
- <para>By default, MailKit initializes this value to support only TLS v1.0 and greater and
- does not support any version of SSL due to those protocols no longer being considered
- secure.</para>
- <para>This property should be set before calling any of the
- <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> methods.</para>
- </remarks>
- <value>The SSL and TLS protocol versions that are supported.</value>
- </member>
- <member name="P:MailKit.IMailService.ClientCertificates">
- <summary>
- Get or set the client SSL certificates.
- </summary>
- <remarks>
- <para>Some servers may require the client SSL certificates in order
- to allow the user to connect.</para>
- <para>This property should be set before calling any of the
- <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> methods.</para>
- </remarks>
- <value>The client SSL certificates.</value>
- </member>
- <member name="P:MailKit.IMailService.CheckCertificateRevocation">
- <summary>
- Get or set whether connecting via SSL/TLS should check certificate revocation.
- </summary>
- <remarks>
- <para>Gets or sets whether connecting via SSL/TLS should check certificate revocation.</para>
- <para>Normally, the value of this property should be set to <c>true</c> (the default) for security
- reasons, but there are times when it may be necessary to set it to <c>false</c>.</para>
- <para>For example, most Certificate Authorities are probably pretty good at keeping their CRL and/or
- OCSP servers up 24/7, but occasionally they do go down or are otherwise unreachable due to other
- network problems between the client and the Certificate Authority. When this happens, it becomes
- impossible to check the revocation status of one or more of the certificates in the chain
- resulting in an <see cref="T:MailKit.Security.SslHandshakeException"/> being thrown in the
- <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> method. If this becomes a problem,
- it may become desirable to set <see cref="P:MailKit.IMailService.CheckCertificateRevocation"/> to <c>false</c>.</para>
- </remarks>
- <value><c>true</c> if certificate revocation should be checked; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailService.ServerCertificateValidationCallback">
- <summary>
- Get or sets a callback function to validate the server certificate.
- </summary>
- <remarks>
- <para>Gets or sets a callback function to validate the server certificate.</para>
- <para>This property should be set before calling any of the
- <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> methods.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SslCertificateValidation.cs"/>
- </example>
- <value>The server certificate validation callback function.</value>
- </member>
- <member name="P:MailKit.IMailService.LocalEndPoint">
- <summary>
- Get or set the local IP end point to use when connecting to a remote host.
- </summary>
- <remarks>
- Gets or sets the local IP end point to use when connecting to a remote host.
- </remarks>
- <value>The local IP end point or <c>null</c> to use the default end point.</value>
- </member>
- <member name="P:MailKit.IMailService.ProxyClient">
- <summary>
- Get or set the proxy client to use when connecting to a remote host.
- </summary>
- <remarks>
- Gets or sets the proxy client to use when connecting to a remote host via any of the
- <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> methods.
- </remarks>
- <value>The proxy client.</value>
- </member>
- <member name="P:MailKit.IMailService.AuthenticationMechanisms">
- <summary>
- Get the authentication mechanisms supported by the message service.
- </summary>
- <remarks>
- The authentication mechanisms are queried durring the
- <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> method.
- </remarks>
- <value>The supported authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.IMailService.IsAuthenticated">
- <summary>
- Get whether or not the client is currently authenticated with the mail server.
- </summary>
- <remarks>
- <para>Gets whether or not the client is currently authenticated with the mail server.</para>
- <para>To authenticate with the mail server, use one of the
- <a href="Overload_MailKit_MailService_Authenticate.htm">Authenticate</a> methods
- or any of the Async alternatives.</para>
- </remarks>
- <value><c>true</c> if the client is authenticated; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailService.IsConnected">
- <summary>
- Get whether or not the service is currently connected.
- </summary>
- <remarks>
- <para>The <see cref="P:MailKit.IMailService.IsConnected"/> state is set to <c>true</c> immediately after
- one of the <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a>
- methods succeeds and is not set back to <c>false</c> until either the client
- is disconnected via <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until a
- <see cref="T:MailKit.ProtocolException"/> is thrown while attempting to read or write to
- the underlying network socket.</para>
- <para>When an <see cref="T:MailKit.ProtocolException"/> is caught, the connection state of the
- <see cref="T:MailKit.IMailService"/> should be checked before continuing.</para>
- </remarks>
- <value><c>true</c> if the service connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailService.IsSecure">
- <summary>
- Get whether or not the connection is secure (typically via SSL or TLS).
- </summary>
- <remarks>
- Gets whether or not the connection is secure (typically via SSL or TLS).
- </remarks>
- <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailService.Timeout">
- <summary>
- Get or set the timeout for network streaming operations, in milliseconds.
- </summary>
- <remarks>
- Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
- and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
- </remarks>
- <value>The timeout in milliseconds.</value>
- </member>
- <member name="M:MailKit.IMailService.Connect(System.String,System.Int32,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server.
- </summary>
- <remarks>
- <para>Establish a connection to the specified mail server.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="useSsl"><value>true</value> if the client should make an SSL-wrapped connection to the server; otherwise, <value>false</value>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.ConnectAsync(System.String,System.Int32,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="useSsl"><value>true</value> if the client should make an SSL-wrapped connection to the server; otherwise, <value>false</value>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server.
- </summary>
- <remarks>
- <para>Establish a connection to the specified mail server.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server using the provided socket.
- </summary>
- <remarks>
- <para>Establish a connection to the specified mail server using the provided socket.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server using the provided socket.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server using the provided socket.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server using the provided stream.
- </summary>
- <remarks>
- <para>Establish a connection to the specified mail server using the provided stream.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server using the provided stream.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server using the provided stream.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Authenticate(System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>Authenticates using the supplied credentials.</para>
- <para>If the server supports one or more SASL authentication mechanisms, then
- the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.AuthenticateAsync(System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>Asynchronously authenticates using the supplied credentials.</para>
- <para>If the server supports one or more SASL authentication mechanisms, then
- the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>Authenticates using the supplied credentials.</para>
- <para>If the server supports one or more SASL authentication mechanisms, then
- the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>Asynchronously authenticates using the supplied credentials.</para>
- <para>If the server supports one or more SASL authentication mechanisms, then
- the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Authenticate(System.Text.Encoding,System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.AuthenticateAsync(System.Text.Encoding,System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Authenticate(System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.AuthenticateAsync(System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Disconnect the service.
- </summary>
- <remarks>
- <para>Disconnects from the service.</para>
- <para>If <paramref name="quit"/> is <c>true</c>, a "QUIT" command will be issued in order to disconnect cleanly.</para>
- </remarks>
- <param name="quit">If set to <c>true</c>, a "QUIT" command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously disconnect the service.
- </summary>
- <remarks>
- <para>Asynchronously disconnects from the service.</para>
- <para>If <paramref name="quit"/> is <c>true</c>, a "QUIT" command will be issued in order to disconnect cleanly.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="quit">If set to <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.NoOp(System.Threading.CancellationToken)">
- <summary>
- Ping the message service to keep the connection alive.
- </summary>
- <remarks>
- Mail servers, if left idle for too long, will automatically drop the connection.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.NoOpAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously ping the mail server to keep the connection alive.
- </summary>
- <remarks>
- Mail servers, if left idle for too long, will automatically drop the connection.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="E:MailKit.IMailService.Connected">
- <summary>
- Occurs when the client has been successfully connected.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailService.Connected"/> event is raised when the client
- successfully connects to the mail server.
- </remarks>
- </member>
- <member name="E:MailKit.IMailService.Disconnected">
- <summary>
- Occurs when the client has been disconnected.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailService.Disconnected"/> event is raised whenever the client
- has been disconnected.
- </remarks>
- </member>
- <member name="E:MailKit.IMailService.Authenticated">
- <summary>
- Occurs when the client has been successfully authenticated.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailService.Authenticated"/> event is raised whenever the client
- has been authenticated.
- </remarks>
- </member>
- <member name="T:MailKit.IMailSpool">
- <summary>
- An interface for retreiving messages from a spool.
- </summary>
- <remarks>
- An interface for retreiving messages from a spool.
- </remarks>
- </member>
- <member name="P:MailKit.IMailSpool.Count">
- <summary>
- Get the number of messages available in the message spool.
- </summary>
- <remarks>
- <para>Gets the number of messages available in the message spool.</para>
- <para>Once authenticated, the <see cref="P:MailKit.IMailSpool.Count"/> property will be set
- to the number of available messages in the spool.</para>
- </remarks>
- <value>The message count.</value>
- </member>
- <member name="P:MailKit.IMailSpool.SupportsUids">
- <summary>
- Get whether or not the service supports referencing messages by UIDs.
- </summary>
- <remarks>
- <para>Not all servers support referencing messages by UID, so this property should
- be checked before using <see cref="M:MailKit.IMailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/>
- and <see cref="M:MailKit.IMailSpool.GetMessageUids(System.Threading.CancellationToken)"/>.</para>
- <para>If the server does not support UIDs, then all methods that take UID arguments
- along with <see cref="M:MailKit.IMailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/> and
- <see cref="M:MailKit.IMailSpool.GetMessageUids(System.Threading.CancellationToken)"/> will fail.</para>
- </remarks>
- <value><c>true</c> if supports uids; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageCount(System.Threading.CancellationToken)">
- <summary>
- Get the message count.
- </summary>
- <remarks>
- Gets the message count.
- </remarks>
- <returns>The message count.</returns>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the UID of the message at the specified index.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.IMailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message UID.</returns>
- <param name="index">The message index.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageUidAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the UID of the message at the specified index.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.IMailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message UID.</returns>
- <param name="index">The message index.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageUids(System.Threading.CancellationToken)">
- <summary>
- Get the full list of available message UIDs.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.IMailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message UIDs.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageUidsAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the full list of available message UIDs.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.IMailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message UIDs.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageSize(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the size of the specified message, in bytes.
- </summary>
- <remarks>
- Gets the size of the specified message, in bytes.
- </remarks>
- <returns>The message size, in bytes.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageSizeAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the size of the specified message, in bytes.
- </summary>
- <remarks>
- Asynchronously gets the size of the specified message, in bytes.
- </remarks>
- <returns>The message size, in bytes.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageSizes(System.Threading.CancellationToken)">
- <summary>
- Get the sizes for all available messages, in bytes.
- </summary>
- <remarks>
- Gets the sizes for all available messages, in bytes.
- </remarks>
- <returns>The message sizes, in bytes.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageSizesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the sizes for all available messages, in bytes.
- </summary>
- <remarks>
- Asynchronously gets the sizes for all available messages, in bytes.
- </remarks>
- <returns>The message sizes, in bytes.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers for the specified message.
- </summary>
- <remarks>
- Gets the headers for the specified message.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageHeadersAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers for the specified message.
- </summary>
- <remarks>
- Asynchronously gets the headers for the specified message.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageHeaders(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Get the headers for the specified messages.
- </summary>
- <remarks>
- Gets the headers for the specified messages.
- </remarks>
- <returns>The headers for the specified messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageHeadersAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers for the specified messages.
- </summary>
- <remarks>
- Asynchronously gets the headers for the specified messages.
- </remarks>
- <returns>The headers for the specified messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageHeaders(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers of the messages within the specified range.
- </summary>
- <remarks>
- Gets the headers of the messages within the specified range.
- </remarks>
- <returns>The headers of the messages within the specified range.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageHeadersAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers of the messages within the specified range.
- </summary>
- <remarks>
- Gets the headers of the messages within the specified range.
- </remarks>
- <returns>The headers of the messages within the specified range.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message at the specified index.
- </summary>
- <remarks>
- Gets the message at the specified index.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message at the specified index.
- </summary>
- <remarks>
- Asynchronously gets the message at the specified index.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the messages at the specified indexes.
- </summary>
- <remarks>
- Gets the messages at the specified indexes.
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the messages at the specified indexes.
- </summary>
- <remarks>
- Asynchronously gets the messages at the specified indexes.
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessages(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the messages within the specified range.
- </summary>
- <remarks>
- Gets the messages within the specified range.
- </remarks>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the messages within the specified range.
- </summary>
- <remarks>
- Asynchronously gets the messages within the specified range.
- </remarks>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header stream at the specified index.
- </summary>
- <remarks>
- Gets the message or header stream at the specified index.
- </remarks>
- <returns>The message or header stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetStreamAsync(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header stream at the specified index.
- </summary>
- <remarks>
- Asynchronously gets the message or header stream at the specified index.
- </remarks>
- <returns>The message or header stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetStreams(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header streams at the specified index.
- </summary>
- <remarks>
- Gets the message or header streams at the specified index.
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header streams at the specified indexes.
- </summary>
- <remarks>
- Asynchronously gets the message or header streams at the specified indexes.
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetStreams(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header streams within the specified range.
- </summary>
- <remarks>
- Gets the message or header streams within the specified range.
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="startIndex">The index of the first stream to get.</param>
- <param name="count">The number of streams to get.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetStreamsAsync(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header streams within the specified range.
- </summary>
- <remarks>
- Asynchronously gets the message or header streams within the specified range.
- </remarks>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first stream to get.</param>
- <param name="count">The number of streams to get.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteMessage(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Mark the specified message for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteMessageAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified message for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Mark the specified messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteMessages(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Mark the specified range of messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="startIndex">The index of the first message to mark for deletion.</param>
- <param name="count">The number of messages to mark for deletion.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified range of messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="startIndex">The index of the first message to mark for deletion.</param>
- <param name="count">The number of messages to mark for deletion.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteAllMessages(System.Threading.CancellationToken)">
- <summary>
- Mark all messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteAllMessagesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark all messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.Reset(System.Threading.CancellationToken)">
- <summary>
- Reset the state of all messages marked for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.ResetAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously reset the state of all messages marked for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="T:MailKit.IMailStore">
- <summary>
- An interface for retreiving messages from a message store such as IMAP.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Imap.ImapClient"/>.
- </remarks>
- </member>
- <member name="P:MailKit.IMailStore.PersonalNamespaces">
- <summary>
- Get the personal namespaces.
- </summary>
- <remarks>
- The personal folder namespaces contain a user's personal mailbox folders.
- </remarks>
- <value>The personal namespaces.</value>
- </member>
- <member name="P:MailKit.IMailStore.SharedNamespaces">
- <summary>
- Get the shared namespaces.
- </summary>
- <remarks>
- The shared folder namespaces contain mailbox folders that are shared with the user.
- </remarks>
- <value>The shared namespaces.</value>
- </member>
- <member name="P:MailKit.IMailStore.OtherNamespaces">
- <summary>
- Get the other namespaces.
- </summary>
- <remarks>
- The other folder namespaces contain other mailbox folders.
- </remarks>
- <value>The other namespaces.</value>
- </member>
- <member name="P:MailKit.IMailStore.SupportsQuotas">
- <summary>
- Get whether or not the mail store supports quotas.
- </summary>
- <remarks>
- Gets whether or not the mail store supports quotas.
- </remarks>
- <value><c>true</c> if the mail store supports quotas; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailStore.ThreadingAlgorithms">
- <summary>
- Get the threading algorithms supported by the mail store.
- </summary>
- <remarks>
- The threading algorithms are queried as part of the
- <a href="Overload_MailKit_IMailStore_Connect.htm">Connect</a>
- and <a href="Overload_MailKit_IMailStore_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The threading algorithms.</value>
- </member>
- <member name="P:MailKit.IMailStore.Inbox">
- <summary>
- Get the Inbox folder.
- </summary>
- <remarks>
- The Inbox folder is the default folder and is typically the folder
- where all new messages are delivered.
- </remarks>
- <value>The Inbox folder.</value>
- </member>
- <member name="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)">
- <summary>
- Enable the quick resynchronization feature.
- </summary>
- <remarks>
- <para>Enables quick resynchronization when a folder is opened using the
- <see cref="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
- method.</para>
- <para>If this feature is enabled, the <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event
- is replaced with the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event.</para>
- <para>This method needs to be called immediately after
- <see cref="M:MailKit.IMailService.Authenticate(System.Net.ICredentials,System.Threading.CancellationToken)"/>,
- before the opening of any folders.</para>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Quick resynchronization needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quick resynchronization.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.EnableQuickResyncAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable the quick resynchronization feature.
- </summary>
- <remarks>
- <para>Enables quick resynchronization when a folder is opened using the
- <see cref="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
- method.</para>
- <para>If this feature is enabled, the <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event
- is replaced with the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event.</para>
- <para>This method needs to be called immediately after
- <see cref="M:MailKit.IMailService.Authenticate(System.Net.ICredentials,System.Threading.CancellationToken)"/>,
- before the opening of any folders.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Quick resynchronization needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quick resynchronization.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFolder(MailKit.SpecialFolder)">
- <summary>
- Get the specified special folder.
- </summary>
- <remarks>
- Not all message stores support the concept of special folders,
- so this method may return <c>null</c>.
- </remarks>
- <returns>The folder if available; otherwise <c>null</c>.</returns>
- <param name="folder">The type of special folder.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="folder"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFolder(MailKit.FolderNamespace)">
- <summary>
- Get the folder for the specified namespace.
- </summary>
- <remarks>
- The main reason to get the toplevel folder in a namespace is
- to list its child folders.
- </remarks>
- <returns>The folder.</returns>
- <param name="namespace">The namespace.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFolders(MailKit.FolderNamespace,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The namespace folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFoldersAsync(MailKit.FolderNamespace,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Asynchronously gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The namespace folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFolders(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The namespace folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFoldersAsync(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Asynchronously gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The namespace folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFolder(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the folder for the specified path.
- </summary>
- <remarks>
- Gets the folder for the specified path.
- </remarks>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFolderAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the folder for the specified path.
- </summary>
- <remarks>
- Asynchronously gets the folder for the specified path.
- </remarks>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.GetMetadata(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.GetMetadataAsync(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Sets the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the specified metadata.
- </summary>
- <remarks>
- Asynchronously sets the specified metadata.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="E:MailKit.IMailStore.Alert">
- <summary>
- Occurs when a remote message store receives an alert message from the server.
- </summary>
- <remarks>
- Some implementations, such as <see cref="T:MailKit.Net.Imap.ImapClient"/>,
- will emit Alert events when they receive alert messages from the server.
- </remarks>
- </member>
- <member name="E:MailKit.IMailStore.FolderCreated">
- <summary>
- Occurs when a folder is created.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailStore.FolderCreated"/> event is emitted when a new folder is created.
- </remarks>
- </member>
- <member name="E:MailKit.IMailStore.MetadataChanged">
- <summary>
- Occurs when metadata changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailStore.MetadataChanged"/> event is emitted when metadata changes.
- </remarks>
- </member>
- <member name="T:MailKit.IMailTransport">
- <summary>
- An interface for sending messages.
- </summary>
- <remarks>
- An interface for sending messages.
- </remarks>
- </member>
- <member name="M:MailKit.IMailTransport.Send(MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message.
- </summary>
- <remarks>
- <para>Sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.SendAsync(MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message.
- </summary>
- <remarks>
- <para>Asynchronously sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.Send(MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Sends the specified message using the supplied sender and recipients.
- </remarks>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.SendAsync(MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Asynchronously sends the specified message using the supplied sender and recipients.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message.
- </summary>
- <remarks>
- <para>Sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message.
- </summary>
- <remarks>
- <para>Asynchronously sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Sends the specified message using the supplied sender and recipients.
- </remarks>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Asynchronously sends the specified message using the supplied sender and recipients.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="E:MailKit.IMailTransport.MessageSent">
- <summary>
- Occurs when a message is successfully sent via the transport.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailTransport.MessageSent"/> event will be emitted each time a message is successfully sent.
- </remarks>
- </member>
- <member name="T:MailKit.IMessageSummary">
- <summary>
- A summary of a message.
- </summary>
- <remarks>
- A <see cref="T:MailKit.IMessageSummary"/> is returned by
- <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>.
- The properties of the <see cref="T:MailKit.IMessageSummary"/> that will be available
- depend on the <see cref="T:MailKit.MessageSummaryItems"/> passed to the aformentioned method.
- </remarks>
- </member>
- <member name="P:MailKit.IMessageSummary.Fields">
- <summary>
- Get a bitmask of fields that have been populated.
- </summary>
- <remarks>
- Gets a bitmask of fields that have been populated.
- </remarks>
- <value>The fields that have been populated.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Body">
- <summary>
- Gets the body structure of the message, if available.
- </summary>
- <remarks>
- <para>The body will be one of <see cref="T:MailKit.BodyPartText"/>,
- <see cref="T:MailKit.BodyPartMessage"/>, <see cref="T:MailKit.BodyPartBasic"/>,
- or <see cref="T:MailKit.BodyPartMultipart"/>.</para>
- <para>This property will only be set if either the
- <see cref="F:MailKit.MessageSummaryItems.Body"/> flag or the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The body structure of the message.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.TextBody">
- <summary>
- Gets the text body part of the message if it exists.
- </summary>
- <remarks>
- <para>Gets the <c>text/plain</c> body part of the message.</para>
- <para>This property will only be usable if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <value>The text body if it exists; otherwise, <c>null</c>.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.HtmlBody">
- <summary>
- Gets the html body part of the message if it exists.
- </summary>
- <remarks>
- <para>Gets the <c>text/html</c> body part of the message.</para>
- <para>This property will only be usable if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The html body if it exists; otherwise, <c>null</c>.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.BodyParts">
- <summary>
- Gets the body parts of the message.
- </summary>
- <remarks>
- <para>Traverses over the <see cref="P:MailKit.IMessageSummary.Body"/>, enumerating all of the
- <see cref="T:MailKit.BodyPartBasic"/> objects.</para>
- <para>This property will only be usable if either the
- <see cref="F:MailKit.MessageSummaryItems.Body"/> flag or the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The body parts.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Attachments">
- <summary>
- Gets the attachments.
- </summary>
- <remarks>
- <para>Traverses over the <see cref="P:MailKit.IMessageSummary.Body"/>, enumerating all of the
- <see cref="T:MailKit.BodyPartBasic"/> objects that have a <c>Content-Disposition</c>
- header set to <c>"attachment"</c>.</para>
- <para>This property will only be usable if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <value>The attachments.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.PreviewText">
- <summary>
- Gets the preview text of the message.
- </summary>
- <remarks>
- <para>The preview text is a short snippet of the beginning of the message
- text, typically shown in a mail client's message list to provide the user
- with a sense of what the message is about.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.PreviewText"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The preview text.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Envelope">
- <summary>
- Gets the envelope of the message, if available.
- </summary>
- <remarks>
- <para>The envelope of a message contains information such as the
- date the message was sent, the subject of the message,
- the sender of the message, who the message was sent to,
- which message(s) the message may be in reply to,
- and the message id.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Envelope"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The envelope of the message.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.NormalizedSubject">
- <summary>
- Gets the normalized subject.
- </summary>
- <remarks>
- <para>A normalized <c>Subject</c> header value where prefixes such as <c>"Re:"</c>, <c>"Re[#]:"</c> and <c>"FWD:"</c> have been pruned.</para>
- <para>This property is typically used for threading messages by subject.</para>
- </remarks>
- <value>The normalized subject.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Date">
- <summary>
- Gets the Date header value.
- </summary>
- <remarks>
- Gets the Date header value. If the Date header is not present, the arrival date is used.
- If neither are known, <see cref="F:System.DateTimeOffset.MinValue"/> is returned.
- </remarks>
- <value>The date.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.IsReply">
- <summary>
- Gets whether or not the message is a reply.
- </summary>
- <remarks>
- This value should be based on whether the message subject contained any <c>"Re:"</c>, <c>"Re[#]:"</c> or <c>"FWD:"</c> prefixes.
- </remarks>
- <value><c>true</c> if the message is a reply; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Flags">
- <summary>
- Gets the message flags, if available.
- </summary>
- <remarks>
- <para>Gets the message flags, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The message flags.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Keywords">
- <summary>
- Gets the user-defined message flags, if available.
- </summary>
- <remarks>
- <para>Gets the user-defined message flags, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The user-defined message flags.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.UserFlags">
- <summary>
- Gets the user-defined message flags, if available.
- </summary>
- <remarks>
- <para>Gets the user-defined message flags, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The user-defined message flags.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Annotations">
- <summary>
- Gets the message annotations, if available.
- </summary>
- <remarks>
- <para>Gets the message annotations, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Annotations"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The message annotations.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Headers">
- <summary>
- Gets the list of headers, if available.
- </summary>
- <remarks>
- <para>Gets the list of headers, if available.</para>
- <para>This property will only be set if <see cref="F:MailKit.MessageSummaryItems.Headers"/>
- is specified in a call to one of the
- <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods or specific headers are requested via a one of the Fetch or FetchAsync methods
- that accept list of specific headers to request for each message such as
- <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)"/>.
- </para>
- </remarks>
- <value>The list of headers.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.InternalDate">
- <summary>
- Gets the internal date of the message, if available.
- </summary>
- <remarks>
- <para>Gets the internal date of the message (often the same date as found in the <c>Received</c> header), if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.InternalDate"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The internal date of the message.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Size">
- <summary>
- Gets the size of the message, in bytes, if available.
- </summary>
- <remarks>
- <para>Gets the size of the message, in bytes, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Size"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The size of the message.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.ModSeq">
- <summary>
- Gets the mod-sequence value for the message, if available.
- </summary>
- <remarks>
- <para>Gets the mod-sequence value for the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.ModSeq"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The mod-sequence value.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.References">
- <summary>
- Gets the message-ids that the message references, if available.
- </summary>
- <remarks>
- <para>Gets the message-ids that the message references, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.References"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The references.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.EmailId">
- <summary>
- Get the globally unique identifier for the message, if available.
- </summary>
- <remarks>
- <para>Gets the globally unique identifier of the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.EmailId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- <note type="info">This property maps to the <c>EMAILID</c> value defined in the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The globally unique message identifier.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Id">
- <summary>
- Get the globally unique identifier for the message, if available.
- </summary>
- <remarks>
- <para>Gets the globally unique identifier of the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.EmailId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- <note type="info">This property maps to the <c>EMAILID</c> value defined in the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The globally unique message identifier.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.ThreadId">
- <summary>
- Get the globally unique thread identifier for the message, if available.
- </summary>
- <remarks>
- <para>Gets the globally unique thread identifier for the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.ThreadId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- <note type="info">This property maps to the <c>THREADID</c> value defined in the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The globally unique thread identifier.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.UniqueId">
- <summary>
- Gets the unique identifier of the message, if available.
- </summary>
- <remarks>
- <para>Gets the unique identifier of the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.UniqueId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The uid of the message.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Index">
- <summary>
- Gets the index of the message.
- </summary>
- <remarks>
- <para>Gets the index of the message.</para>
- <para>This property is always set.</para>
- </remarks>
- <value>The index of the message.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.GMailMessageId">
- <summary>
- Gets the GMail message identifier, if available.
- </summary>
- <remarks>
- <para>Gets the GMail message identifier, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.GMailMessageId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The GMail message identifier.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.GMailThreadId">
- <summary>
- Gets the GMail thread identifier, if available.
- </summary>
- <remarks>
- <para>Gets the GMail thread identifier, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.GMailThreadId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The GMail thread identifier.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.GMailLabels">
- <summary>
- Gets the list of GMail labels, if available.
- </summary>
- <remarks>
- <para>Gets the list of GMail labels, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.GMailLabels"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The GMail labels.</value>
- </member>
- <member name="T:MailKit.IProtocolLogger">
- <summary>
- An interface for logging the communication between a client and server.
- </summary>
- <remarks>
- An interface for logging the communication between a client and server.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ProtocolLogger" />
- </example>
- </member>
- <member name="M:MailKit.IProtocolLogger.LogConnect(System.Uri)">
- <summary>
- Logs a connection to the specified URI.
- </summary>
- <remarks>
- Logs a connection to the specified URI.
- </remarks>
- <param name="uri">The URI.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uri"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The logger has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Logs a sequence of bytes sent by the client.
- </summary>
- <remarks>
- <para>Logs a sequence of bytes sent by the client.</para>
- <para><see cref="M:MailKit.IProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)"/> is called by the <see cref="T:MailKit.IMailService"/> upon every successful
- write operation to its underlying network stream, passing the exact same <paramref name="buffer"/>,
- <paramref name="offset"/>, and <paramref name="count"/> arguments to the logging function.</para>
- </remarks>
- <param name='buffer'>The buffer to log.</param>
- <param name='offset'>The offset of the first byte to log.</param>
- <param name='count'>The number of bytes to log.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The logger has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Logs a sequence of bytes sent by the server.
- </summary>
- <remarks>
- <para>Logs a sequence of bytes sent by the server.</para>
- <para><see cref="M:MailKit.IProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)"/> is called by the <see cref="T:MailKit.IMailService"/> upon every successful
- read of its underlying network stream with the exact buffer that was read.</para>
- </remarks>
- <param name='buffer'>The buffer to log.</param>
- <param name='offset'>The offset of the first byte to log.</param>
- <param name='count'>The number of bytes to log.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The logger has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="T:MailKit.ITransferProgress">
- <summary>
- An interface for reporting progress of uploading or downloading messages.
- </summary>
- <remarks>
- An interface for reporting progress of uploading or downloading messages.
- </remarks>
- </member>
- <member name="M:MailKit.ITransferProgress.Report(System.Int64,System.Int64)">
- <summary>
- Report the progress of the transfer operation.
- </summary>
- <remarks>
- <para>Reports the progress of the transfer operation.</para>
- <para>This method is only used if the operation knows the size
- of the message, part, or stream being transferred without doing
- extra work to calculate it.</para>
- </remarks>
- <param name="bytesTransferred">The number of bytes transferred.</param>
- <param name="totalSize">The total size, in bytes, of the message, part, or stream being transferred.</param>
- </member>
- <member name="M:MailKit.ITransferProgress.Report(System.Int64)">
- <summary>
- Report the progress of the transfer operation.
- </summary>
- <remarks>
- <para>Reports the progress of the transfer operation.</para>
- </remarks>
- <param name="bytesTransferred">The number of bytes transferred.</param>
- </member>
- <member name="T:MailKit.MailFolder">
- <summary>
- An abstract mail folder implementation.
- </summary>
- <remarks>
- An abstract mail folder implementation.
- </remarks>
- </member>
- <member name="F:MailKit.MailFolder.SettableFlags">
- <summary>
- The bit mask of settable flags.
- </summary>
- <remarks>
- Only flags in the list of settable flags may be set on a message by the client.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.#ctor">
- <summary>
- Initialize a new instance of the <see cref="T:MailKit.MailFolder"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.MailFolder"/> class.
- </remarks>
- </member>
- <member name="P:MailKit.MailFolder.SyncRoot">
- <summary>
- Get an object that can be used to synchronize access to the folder.
- </summary>
- <remarks>
- <para>Gets an object that can be used to synchronize access to the folder.</para>
- </remarks>
- <value>The sync root.</value>
- </member>
- <member name="P:MailKit.MailFolder.ParentFolder">
- <summary>
- Get the parent folder.
- </summary>
- <remarks>
- Root-level folders do not have a parent folder.
- </remarks>
- <value>The parent folder.</value>
- </member>
- <member name="P:MailKit.MailFolder.Attributes">
- <summary>
- Get the folder attributes.
- </summary>
- <remarks>
- Gets the folder attributes.
- </remarks>
- <value>The folder attributes.</value>
- </member>
- <member name="P:MailKit.MailFolder.AnnotationAccess">
- <summary>
- Get the annotation access level.
- </summary>
- <remarks>
- If annotations are supported, this property can be used to determine whether or not
- the <see cref="T:MailKit.IMailFolder"/> supports reading and writing annotations.
- </remarks>
- </member>
- <member name="P:MailKit.MailFolder.AnnotationScopes">
- <summary>
- Get the supported annotation scopes.
- </summary>
- <remarks>
- If annotations are supported, this property can be used to determine which
- annotation scopes are supported by the <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="P:MailKit.MailFolder.MaxAnnotationSize">
- <summary>
- Get the maximum size of annotation values supported by the folder.
- </summary>
- <remarks>
- If annotations are supported, this property can be used to determine the
- maximum size of annotation values supported by the <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="P:MailKit.MailFolder.PermanentFlags">
- <summary>
- Get the permanent flags.
- </summary>
- <remarks>
- <para>The permanent flags are the message flags that will persist between sessions.</para>
- <para>If the <see cref="F:MailKit.MessageFlags.UserDefined"/> flag is set, then the folder allows
- storing of user-defined (custom) message flags.</para>
- </remarks>
- <value>The permanent flags.</value>
- </member>
- <member name="P:MailKit.MailFolder.AcceptedFlags">
- <summary>
- Get the accepted flags.
- </summary>
- <remarks>
- The accepted flags are the message flags that will be accepted and persist
- for the current session. For the set of flags that will persist between
- sessions, see the <see cref="P:MailKit.MailFolder.PermanentFlags"/> property.
- </remarks>
- <value>The accepted flags.</value>
- </member>
- <member name="P:MailKit.MailFolder.DirectorySeparator">
- <summary>
- Get the directory separator.
- </summary>
- <remarks>
- Gets the directory separator.
- </remarks>
- <value>The directory separator.</value>
- </member>
- <member name="P:MailKit.MailFolder.Access">
- <summary>
- Get the read/write access of the folder.
- </summary>
- <remarks>
- Gets the read/write access of the folder.
- </remarks>
- <value>The read/write access.</value>
- </member>
- <member name="P:MailKit.MailFolder.IsNamespace">
- <summary>
- Get whether or not the folder is a namespace folder.
- </summary>
- <remarks>
- Gets whether or not the folder is a namespace folder.
- </remarks>
- <value><c>true</c> if the folder is a namespace folder; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailFolder.FullName">
- <summary>
- Get the full name of the folder.
- </summary>
- <remarks>
- This is the equivalent of the full path of a file on a file system.
- </remarks>
- <value>The full name of the folder.</value>
- </member>
- <member name="P:MailKit.MailFolder.Name">
- <summary>
- Get the name of the folder.
- </summary>
- <remarks>
- This is the equivalent of the file name of a file on the file system.
- </remarks>
- <value>The name of the folder.</value>
- </member>
- <member name="P:MailKit.MailFolder.Id">
- <summary>
- Get the unique identifier for the folder, if available.
- </summary>
- <remarks>
- <para>Gets a unique identifier for the folder, if available. This is useful for clients
- implementing a message cache that want to track the folder after it is renamed by another
- client.</para>
- <note type="note">This property will only be available if the server supports the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The unique folder identifier.</value>
- </member>
- <member name="P:MailKit.MailFolder.IsSubscribed">
- <summary>
- Get a value indicating whether the folder is subscribed.
- </summary>
- <remarks>
- Gets a value indicating whether the folder is subscribed.
- </remarks>
- <value><c>true</c> if the folder is subscribed; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailFolder.IsOpen">
- <summary>
- Get a value indicating whether the folder is currently open.
- </summary>
- <remarks>
- Gets a value indicating whether the folder is currently open.
- </remarks>
- <value><c>true</c> if the folder is currently open; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailFolder.Exists">
- <summary>
- Get a value indicating whether the folder exists.
- </summary>
- <remarks>
- Gets a value indicating whether the folder exists.
- </remarks>
- <value><c>true</c> if the folder exists; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailFolder.SupportsModSeq">
- <summary>
- Get whether or not the folder supports mod-sequences.
- </summary>
- <remarks>
- <para>If mod-sequences are not supported by the folder, then all of the APIs that take a modseq
- argument will throw <see cref="T:System.NotSupportedException"/> and should not be used.</para>
- </remarks>
- <value><c>true</c> if supports mod-sequences; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailFolder.HighestModSeq">
- <summary>
- Get the highest mod-sequence value of all messages in the mailbox.
- </summary>
- <remarks>
- Gets the highest mod-sequence value of all messages in the mailbox.
- </remarks>
- <value>The highest mod-sequence value.</value>
- </member>
- <member name="P:MailKit.MailFolder.UidValidity">
- <summary>
- Get the UID validity.
- </summary>
- <remarks>
- <para>UIDs are only valid so long as the UID validity value remains unchanged. If and when
- the folder's <see cref="P:MailKit.MailFolder.UidValidity"/> is changed, a client MUST discard its cache of UIDs
- along with any summary information that it may have and re-query the folder.</para>
- <para>This value will only be set after the folder has been opened.</para>
- </remarks>
- <value>The UID validity.</value>
- </member>
- <member name="P:MailKit.MailFolder.UidNext">
- <summary>
- Get the UID that the folder will assign to the next message that is added.
- </summary>
- <remarks>
- This value will only be set after the folder has been opened.
- </remarks>
- <value>The next UID.</value>
- </member>
- <member name="P:MailKit.MailFolder.AppendLimit">
- <summary>
- Get the maximum size of a message that can be appended to the folder.
- </summary>
- <remarks>
- <para>Gets the maximum size of a message that can be appended to the folder.</para>
- <note type="note">If the value is not set, then the limit is unspecified.</note>
- </remarks>
- <value>The append limit.</value>
- </member>
- <member name="P:MailKit.MailFolder.Size">
- <summary>
- Get the size of the folder.
- </summary>
- <remarks>
- <para>Gets the size of the folder in bytes.</para>
- <note type="note">If the value is not set, then the size is unspecified.</note>
- </remarks>
- <value>The size.</value>
- </member>
- <member name="P:MailKit.MailFolder.FirstUnread">
- <summary>
- Get the index of the first unread message in the folder.
- </summary>
- <remarks>
- This value will only be set after the folder has been opened.
- </remarks>
- <value>The index of the first unread message.</value>
- </member>
- <member name="P:MailKit.MailFolder.Unread">
- <summary>
- Get the number of unread messages in the folder.
- </summary>
- <remarks>
- <para>Gets the number of unread messages in the folder.</para>
- <note type="note">This value will only be set after calling
- <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- with <see cref="F:MailKit.StatusItems.Unread"/>.</note>
- </remarks>
- <value>The number of unread messages.</value>
- </member>
- <member name="P:MailKit.MailFolder.Recent">
- <summary>
- Get the number of recently added messages in the folder.
- </summary>
- <remarks>
- <para>Gets the number of recently delivered messages in the folder.</para>
- <note type="note">This value will only be set after calling
- <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- with <see cref="F:MailKit.StatusItems.Recent"/> or by opening the folder.</note>
- </remarks>
- <value>The number of recently added messages.</value>
- </member>
- <member name="P:MailKit.MailFolder.Count">
- <summary>
- Get the total number of messages in the folder.
- </summary>
- <remarks>
- <para>Gets the total number of messages in the folder.</para>
- <note type="note">This value will only be set after calling
- <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- with <see cref="F:MailKit.StatusItems.Count"/> or by opening the folder.</note>
- </remarks>
- <value>The total number of messages.</value>
- </member>
- <member name="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Opens the folder using the requested folder access.
- </summary>
- <remarks>
- <para>This variant of the <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- method is meant for quick resynchronization of the folder. Before calling this method,
- the <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
- <para>You should also make sure to add listeners to the <see cref="E:MailKit.MailFolder.MessagesVanished"/> and
- <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events to get notifications of changes since
- the last time the folder was opened.</para>
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="uidValidity">The last known <see cref="P:MailKit.MailFolder.UidValidity"/> value.</param>
- <param name="highestModSeq">The last known <see cref="P:MailKit.MailFolder.HighestModSeq"/> value.</param>
- <param name="uids">The last known list of unique message identifiers.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The quick resynchronization feature has not been enabled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the quick resynchronization feature.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.OpenAsync(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously opens the folder using the requested folder access.
- </summary>
- <remarks>
- <para>This variant of the <see cref="M:MailKit.MailFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- method is meant for quick resynchronization of the folder. Before calling this method,
- the <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
- <para>You should also make sure to add listeners to the <see cref="E:MailKit.MailFolder.MessagesVanished"/> and
- <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events to get notifications of changes since
- the last time the folder was opened.</para>
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="uidValidity">The last known <see cref="P:MailKit.MailFolder.UidValidity"/> value.</param>
- <param name="highestModSeq">The last known <see cref="P:MailKit.MailFolder.HighestModSeq"/> value.</param>
- <param name="uids">The last known list of unique message identifiers.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The quick resynchronization feature has not been enabled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the quick resynchronization feature.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)">
- <summary>
- Open the folder using the requested folder access.
- </summary>
- <remarks>
- Opens the folder using the requested folder access.
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)">
- <summary>
- Asynchronously open the folder using the requested folder access.
- </summary>
- <remarks>
- Asynchronously opens the folder using the requested folder access.
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Close(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Close the folder, optionally expunging the messages marked for deletion.
- </summary>
- <remarks>
- Closes the folder, optionally expunging the messages marked for deletion.
- </remarks>
- <param name="expunge">If set to <c>true</c>, expunge.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CloseAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously close the folder, optionally expunging the messages marked for deletion.
- </summary>
- <remarks>
- Asynchronously closes the folder, optionally expunging the messages marked for deletion.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="expunge">If set to <c>true</c>, expunge.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Create(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CreateAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Asynchronously creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Create(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUses">A list of special uses for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="specialUses"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailService"/> does not support the creation of special folders.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CreateAsync(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Asynchronously creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUses">A list of special uses for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="specialUses"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailService"/> does not support the creation of special folders.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Create(System.String,MailKit.SpecialFolder,System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUse">The special use for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailService"/> does not support the creation of special folders.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CreateAsync(System.String,MailKit.SpecialFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Asynchronously creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUse">The special use for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailService"/> does not support the creation of special folders.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Rename(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
- <summary>
- Rename the folder.
- </summary>
- <remarks>
- Renames the folder.
- </remarks>
- <param name="parent">The new parent folder.</param>
- <param name="name">The new name of the folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="parent"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="parent"/> does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is not a legal folder name.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be renamed (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RenameAsync(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously rename the folder.
- </summary>
- <remarks>
- Asynchronously renames the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="parent">The new parent folder.</param>
- <param name="name">The new name of the folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="parent"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="parent"/> does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is not a legal folder name.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be renamed (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Delete(System.Threading.CancellationToken)">
- <summary>
- Delete the folder.
- </summary>
- <remarks>
- Deletes the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be deleted (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.DeleteAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously delete the folder.
- </summary>
- <remarks>
- Asynchronously deletes the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be deleted (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Subscribe(System.Threading.CancellationToken)">
- <summary>
- Subscribe to the folder.
- </summary>
- <remarks>
- Subscribes to the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SubscribeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously subscribe to the folder.
- </summary>
- <remarks>
- Asynchronously subscribes to the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Unsubscribe(System.Threading.CancellationToken)">
- <summary>
- Unsubscribe from the folder.
- </summary>
- <remarks>
- Unsubscribes from the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.UnsubscribeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously unsubscribe from the folder.
- </summary>
- <remarks>
- Asynchronously unsubscribes from the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetSubfolders(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get the subfolders.
- </summary>
- <remarks>
- <para>Gets the subfolders as well as queries the server for the status of the requested items.</para>
- <para>When the <paramref name="items"/> argument is non-empty, this has the equivalent functionality
- of calling <see cref="M:MailKit.MailFolder.GetSubfolders(System.Boolean,System.Threading.CancellationToken)"/> and then calling
- <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> on each of the returned folders.</para>
- </remarks>
- <returns>The subfolders.</returns>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetSubfoldersAsync(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the subfolders.
- </summary>
- <remarks>
- <para>Asynchronously gets the subfolders as well as queries the server for the status of the requested items.</para>
- <para>When the <paramref name="items"/> argument is non-empty, this has the equivalent functionality
- of calling <see cref="M:MailKit.MailFolder.GetSubfoldersAsync(System.Boolean,System.Threading.CancellationToken)"/> and then calling
- <see cref="M:MailKit.MailFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)"/> on each of the returned folders.</para>
- </remarks>
- <returns>The subfolders.</returns>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetSubfolders(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get the subfolders.
- </summary>
- <remarks>
- Gets the subfolders.
- </remarks>
- <returns>The subfolders.</returns>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetSubfoldersAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the subfolders.
- </summary>
- <remarks>
- Asynchronously gets the subfolders.
- </remarks>
- <returns>The subfolders.</returns>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetSubfolder(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the specified subfolder.
- </summary>
- <remarks>
- Gets the specified subfolder.
- </remarks>
- <returns>The subfolder.</returns>
- <param name="name">The name of the subfolder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is either an empty string or contains the <see cref="P:MailKit.MailFolder.DirectorySeparator"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The requested folder could not be found.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetSubfolderAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the specified subfolder.
- </summary>
- <remarks>
- Asynchronously gets the specified subfolder.
- </remarks>
- <returns>The subfolder.</returns>
- <param name="name">The name of the subfolder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is either an empty string or contains the <see cref="P:MailKit.MailFolder.DirectorySeparator"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The requested folder could not be found.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Check(System.Threading.CancellationToken)">
- <summary>
- Force the server to flush its state for the folder.
- </summary>
- <remarks>
- Forces the server to flush its state for the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CheckAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously force the server to flush its state for the folder.
- </summary>
- <remarks>
- Asynchronously forces the server to flush its state for the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)">
- <summary>
- Update the values of the specified items.
- </summary>
- <remarks>
- <para>Updates the values of the specified items.</para>
- <para>The <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
- MUST NOT be used on a folder that is already in the opened state. Instead, other ways
- of getting the desired information should be used.</para>
- <para>For example, a common use for the <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- method is to get the number of unread messages in the folder. When the folder is open, however, it is
- possible to use the <see cref="M:MailKit.MailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
- method to query for the list of unread messages.</para>
- </remarks>
- <param name="items">The items to update.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the STATUS command.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously update the values of the specified items.
- </summary>
- <remarks>
- <para>Updates the values of the specified items.</para>
- <para>The <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
- MUST NOT be used on a folder that is already in the opened state. Instead, other ways
- of getting the desired information should be used.</para>
- <para>For example, a common use for the <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- method is to get the number of unread messages in the folder. When the folder is open, however, it is
- possible to use the <see cref="M:MailKit.MailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
- method to query for the list of unread messages.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="items">The items to update.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the STATUS command.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetAccessControlList(System.Threading.CancellationToken)">
- <summary>
- Get the complete access control list for the folder.
- </summary>
- <remarks>
- Gets the complete access control list for the folder.
- </remarks>
- <returns>The access control list.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetAccessControlListAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the complete access control list for the folder.
- </summary>
- <remarks>
- Asynchronously gets the complete access control list for the folder.
- </remarks>
- <returns>The access control list.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetAccessRights(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the access rights for a particular identifier.
- </summary>
- <remarks>
- Gets the access rights for a particular identifier.
- </remarks>
- <returns>The access rights.</returns>
- <param name="name">The identifier name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetAccessRightsAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for a particular identifier.
- </summary>
- <remarks>
- Asynchronously gets the access rights for a particular identifier.
- </remarks>
- <returns>The access rights.</returns>
- <param name="name">The identifier name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMyAccessRights(System.Threading.CancellationToken)">
- <summary>
- Get the access rights for the current authenticated user.
- </summary>
- <remarks>
- Gets the access rights for the current authenticated user.
- </remarks>
- <returns>The access rights.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMyAccessRightsAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for the current authenticated user.
- </summary>
- <remarks>
- Asynchronously gets the access rights for the current authenticated user.
- </remarks>
- <returns>The access rights.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Add access rights for the specified identity.
- </summary>
- <remarks>
- Adds the given access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add access rights for the specified identity.
- </summary>
- <remarks>
- Asynchronously adds the given access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Remove access rights for the specified identity.
- </summary>
- <remarks>
- Removes the given access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove access rights for the specified identity.
- </summary>
- <remarks>
- Asynchronously removes the given access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Set the access rights for the specified identity.
- </summary>
- <remarks>
- Sets the access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the access rights for the specified identity.
- </summary>
- <remarks>
- Asynchronously sets the access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveAccess(System.String,System.Threading.CancellationToken)">
- <summary>
- Remove all access rights for the given identity.
- </summary>
- <remarks>
- Removes all access rights for the given identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveAccessAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove all access rights for the given identity.
- </summary>
- <remarks>
- Asynchronously removes all access rights for the given identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetQuota(System.Threading.CancellationToken)">
- <summary>
- Get the quota information for the folder.
- </summary>
- <remarks>
- <para>Gets the quota information for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quotas.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetQuotaAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the quota information for the folder.
- </summary>
- <remarks>
- <para>Asynchronously gets the quota information for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quotas.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetQuota(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
- <summary>
- Set the quota limits for the folder.
- </summary>
- <remarks>
- <para>Sets the quota limits for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The updated folder quota.</returns>
- <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
- <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quotas.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetQuotaAsync(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the quota limits for the folder.
- </summary>
- <remarks>
- <para>Asynchronously sets the quota limits for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The updated folder quota.</returns>
- <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
- <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quotas.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMetadata(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="tags"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMetadataAsync(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="tags"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Sets the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the specified metadata.
- </summary>
- <remarks>
- Asynchronously sets the specified metadata.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Expunge(System.Threading.CancellationToken)">
- <summary>
- Expunge the folder, permanently removing all messages marked for deletion.
- </summary>
- <remarks>
- <para>Expunges the folder, permanently removing all messages marked for deletion.</para>
- <note type="note">Normally, an <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.ExpungeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously expunge the folder, permanently removing all messages marked for deletion.
- </summary>
- <remarks>
- <para>Asynchronously expunges the folder, permanently removing all messages marked for deletion.</para>
- <note type="note">Normally, an <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Expunge the specified uids, permanently removing them from the folder.
- </summary>
- <remarks>
- <para>Expunges the specified uids, permanently removing them from the folder.</para>
- <note type="note">Normally, an <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <param name="uids">The message uids.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.ExpungeAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously expunge the specified uids, permanently removing them from the folder.
- </summary>
- <remarks>
- <para>Asynchronously expunges the specified uids, permanently removing them from the folder.</para>
- <note type="note">Normally, an <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The message uids.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- One or more <paramref name="annotations"/> does not define any properties.
- </exception>"
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- One or more <paramref name="annotations"/> does not define any properties.
- </exception>"
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages does not match the number of flags.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages does not match the number of flags.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="dates"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages, flags, and dates do not match.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="dates"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages, flags, and dates do not match.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages does not match the number of flags.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages does not match the number of flags.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="dates"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages, flags, and dates do not match.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="dates"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages, flags, and dates do not match.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyTo(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified message to the destination folder.
- </summary>
- <remarks>
- Copies the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyToAsync(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveTo(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified message to the destination folder.
- </summary>
- <remarks>
- Moves the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveToAsync(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified messages to the destination folder.
- </summary>
- <remarks>
- Moves the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyTo(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified message to the destination folder.
- </summary>
- <remarks>
- Copies the specified message to the destination folder.
- </remarks>
- <param name="index">The index of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> does not refer to a valid message index.
- </exception>
- <exception cref="T:System.ArgumentException">
- The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyToAsync(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified message to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The indexes of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> does not refer to a valid message index.
- </exception>
- <exception cref="T:System.ArgumentException">
- The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <param name="indexes">The indexes of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified messages to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveTo(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified message to the destination folder.
- </summary>
- <remarks>
- Moves the specified message to the destination folder.
- </remarks>
- <param name="index">The index of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> does not refer to a valid message index.
- </exception>
- <exception cref="T:System.ArgumentException">
- The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveToAsync(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified message to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> does not refer to a valid message index.
- </exception>
- <exception cref="T:System.ArgumentException">
- The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified messages to the destination folder.
- </summary>
- <remarks>
- Moves the specified messages to the destination folder.
- </remarks>
- <param name="indexes">The indexes of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified messages to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes that have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes that have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes that have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes
- (inclusive) that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes (inclusive) that have a higher mod-sequence value than the
- one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes
- (inclusive) that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes (inclusive) that have a higher mod-sequence value than the
- one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes
- (inclusive) that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes (inclusive) that have a higher mod-sequence value than the
- one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeaders(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeadersAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message headers.
- </summary>
- <remarks>
- Asynchronously gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeaders(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeadersAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Asynchronously gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeaders(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeadersAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message headers.
- </summary>
- <remarks>
- Asynchronously gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeaders(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeadersAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Asynchronously gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMessageAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message.
- </summary>
- <remarks>
- Asynchronously gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message.
- </summary>
- <remarks>
- Asynchronously gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetBodyPart(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetBodyPartAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Asynchronously gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetBodyPart(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetBodyPartAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Asynchronously gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- Gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- Asynchronously gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- Gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- Asynchronously gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(MailKit.UniqueId,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified body part.
- </summary>
- <remarks>
- Gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(MailKit.UniqueId,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified body part.
- </summary>
- <remarks>
- Asynchronously gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(System.Int32,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified body part.
- </summary>
- <remarks>
- Gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(System.Int32,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified body part.
- </summary>
- <remarks>
- Asynchronously gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message. If the starting
- offset is beyond the end of the specified section of the message, an empty stream
- is returned. If the number of bytes desired extends beyond the end of the section,
- a truncated stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified body part.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified body part.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message. If the starting
- offset is beyond the end of the specified section of the message, an empty stream
- is returned. If the number of bytes desired extends beyond the end of the section,
- a truncated stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="uid">The UIDs of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="uid">The UIDs of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="uid">The UIDs of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="uid">The UIDs of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified message.
- </summary>
- <remarks>
- Adds a set of labels to the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified message.
- </summary>
- <remarks>
- Removes a set of labels from the specified message.
- </remarks>
- <param name="uid">The UIDs of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified message.
- </summary>
- <remarks>
- Sets the labels of the specified message.
- </remarks>
- <param name="uid">The UIDs of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified message.
- </summary>
- <remarks>
- Adds a set of labels to the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified message.
- </summary>
- <remarks>
- Removes a set of labels from the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified message.
- </summary>
- <remarks>
- Sets the labels of the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Store(MailKit.UniqueId,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified message.
- </summary>
- <remarks>
- Stores the annotations for the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="annotations"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StoreAsync(MailKit.UniqueId,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified message.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="annotations"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages.
- </summary>
- <remarks>
- Stores the annotations for the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Store(System.Int32,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified message.
- </summary>
- <remarks>
- Stores the annotations for the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="annotations"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="index"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StoreAsync(System.Int32,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified message.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The indexes of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="annotations"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="index"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Store(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages.
- </summary>
- <remarks>
- Stores the annotations for the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Store(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.s
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- One or more search terms in the <paramref name="query"/> are not supported by the mail store.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SearchAsync(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- One or more search terms in the <paramref name="query"/> are not supported by the mail store.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Search(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- One or more search terms in the <paramref name="query"/> are not supported by the mail store.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SearchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- One or more search terms in the <paramref name="query"/> are not supported.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Search(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.MailFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SearchAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.MailFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Search(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- Searches the fsubset of UIDs in the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SearchAsync(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the fsubset of UIDs in the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- /// <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SortAsync(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Sort(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is empty.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SortAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is empty.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Sort(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.MailFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SortAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.MailFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Sort(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is empty.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SortAsync(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query, returning the search results in the specified sort order.
- </summary>
- <remarks>
- Asynchronously searches the folder for messages matching the specified query,
- returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is empty.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Thread(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support threading search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.ThreadAsync(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support threading search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Thread(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support threading search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.ThreadAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support threading search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="E:MailKit.MailFolder.Opened">
- <summary>
- Occurs when the folder is opened.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.Opened"/> event is emitted when the folder is opened.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnOpened">
- <summary>
- Raise the opened event.
- </summary>
- <remarks>
- Raises the opened event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.Closed">
- <summary>
- Occurs when the folder is closed.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.Closed"/> event is emitted when the folder is closed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnClosed">
- <summary>
- Raise the closed event.
- </summary>
- <remarks>
- Raises the closed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.Deleted">
- <summary>
- Occurs when the folder is deleted.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.Deleted"/> event is emitted when the folder is deleted.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnDeleted">
- <summary>
- Raise the deleted event.
- </summary>
- <remarks>
- Raises the deleted event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.Renamed">
- <summary>
- Occurs when the folder is renamed.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.Renamed"/> event is emitted when the folder is renamed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnRenamed(System.String,System.String)">
- <summary>
- Raise the renamed event.
- </summary>
- <remarks>
- Raises the renamed event.
- </remarks>
- <param name="oldName">The old name of the folder.</param>
- <param name="newName">The new name of the folder.</param>
- </member>
- <member name="M:MailKit.MailFolder.OnParentFolderRenamed">
- <summary>
- Notifies the folder that a parent folder has been renamed.
- </summary>
- <remarks>
- <see cref="T:MailKit.IMailFolder"/> implementations should override this method
- to update their state (such as updating their <see cref="P:MailKit.MailFolder.FullName"/>
- property).
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.Subscribed">
- <summary>
- Occurs when the folder is subscribed.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.Subscribed"/> event is emitted when the folder is subscribed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnSubscribed">
- <summary>
- Raise the subscribed event.
- </summary>
- <remarks>
- Raises the subscribed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.Unsubscribed">
- <summary>
- Occurs when the folder is unsubscribed.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.Unsubscribed"/> event is emitted when the folder is unsubscribed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnUnsubscribed">
- <summary>
- Raise the unsubscribed event.
- </summary>
- <remarks>
- Raises the unsubscribed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.MessageExpunged">
- <summary>
- Occurs when a message is expunged from the folder.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is emitted when a message is expunged from the folder.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- </member>
- <member name="M:MailKit.MailFolder.OnMessageExpunged(MailKit.MessageEventArgs)">
- <summary>
- Raise the message expunged event.
- </summary>
- <remarks>
- Raises the message expunged event.
- </remarks>
- <param name="args">The message expunged event args.</param>
- </member>
- <member name="E:MailKit.MailFolder.MessagesVanished">
- <summary>
- Occurs when a message vanishes from the folder.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.MessagesVanished"/> event is emitted when messages vanish from the folder.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnMessagesVanished(MailKit.MessagesVanishedEventArgs)">
- <summary>
- Raise the messages vanished event.
- </summary>
- <remarks>
- Raises the messages vanished event.
- </remarks>
- <param name="args">The messages vanished event args.</param>
- </member>
- <member name="E:MailKit.MailFolder.MessageFlagsChanged">
- <summary>
- Occurs when flags changed on a message.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> event is emitted when the flags for a message are changed.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- </member>
- <member name="M:MailKit.MailFolder.OnMessageFlagsChanged(MailKit.MessageFlagsChangedEventArgs)">
- <summary>
- Raise the message flags changed event.
- </summary>
- <remarks>
- Raises the message flags changed event.
- </remarks>
- <param name="args">The message flags changed event args.</param>
- </member>
- <member name="E:MailKit.MailFolder.MessageLabelsChanged">
- <summary>
- Occurs when labels changed on a message.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> event is emitted when the labels for a message are changed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnMessageLabelsChanged(MailKit.MessageLabelsChangedEventArgs)">
- <summary>
- Raise the message labels changed event.
- </summary>
- <remarks>
- Raises the message labels changed event.
- </remarks>
- <param name="args">The message labels changed event args.</param>
- </member>
- <member name="E:MailKit.MailFolder.AnnotationsChanged">
- <summary>
- Occurs when annotations changed on a message.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.AnnotationsChanged"/> event is emitted when the annotations for a message are changed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnAnnotationsChanged(MailKit.AnnotationsChangedEventArgs)">
- <summary>
- Raise the message annotations changed event.
- </summary>
- <remarks>
- Raises the message annotations changed event.
- </remarks>
- <param name="args">The message annotations changed event args.</param>
- </member>
- <member name="E:MailKit.MailFolder.MessageSummaryFetched">
- <summary>
- Occurs when a message summary is fetched from the folder.
- </summary>
- <remarks>
- <para>Emitted when a message summary is fetched from the folder.</para>
- <para>When multiple message summaries are being fetched from a remote folder,
- it is possible that the connection will drop or some other exception will
- occur, causing the Fetch method to fail and lose all of the data that has been
- downloaded up to that point, requiring the client to request the same set of
- message summaries all over again after it reconnects. This is obviously
- inefficient. To alleviate this potential problem, this event will be emitted
- as soon as the <see cref="T:MailKit.IMailFolder"/> successfully parses each untagged FETCH
- response from the server, allowing the client to commit this data immediately to
- its local cache.</para>
- <note type="note">Depending on the IMAP server, it is possible that the
- <see cref="E:MailKit.MailFolder.MessageSummaryFetched"/> event will be emitted for the same message
- multiple times if the IMAP server happens to split the requested fields into
- multiple untagged FETCH responses. Use the <see cref="P:MailKit.IMessageSummary.Fields"/>
- property to determine which f<see cref="T:MailKit.IMessageSummary"/> properties have
- been populated.</note>
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnMessageSummaryFetched(MailKit.IMessageSummary)">
- <summary>
- Raise the message summary fetched event.
- </summary>
- <remarks>
- <para>Raises the message summary fetched event.</para>
- <para>When multiple message summaries are being fetched from a remote folder,
- it is possible that the connection will drop or some other exception will
- occur, causing the Fetch method to fail and lose all of the data that has been
- downloaded up to that point, requiring the client to request the same set of
- message summaries all over again after it reconnects. This is obviously
- inefficient. To alleviate this potential problem, this event will be emitted
- as soon as the <see cref="T:MailKit.IMailFolder"/> successfully parses each untagged FETCH
- response from the server, allowing the client to commit this data immediately to
- its local cache.</para>
- <note type="note">Depending on the IMAP server, it is possible that
- <see cref="M:MailKit.MailFolder.OnMessageSummaryFetched(MailKit.IMessageSummary)"/> will be invoked for the same message
- multiple times if the IMAP server happens to split the requested fields into
- multiple untagged FETCH responses. Use the <see cref="P:MailKit.IMessageSummary.Fields"/>
- property to determine which f<see cref="T:MailKit.IMessageSummary"/> properties have
- been populated.</note>
- </remarks>
- <param name="message">The message summary.</param>
- </member>
- <member name="E:MailKit.MailFolder.MetadataChanged">
- <summary>
- Occurs when metadata changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.MetadataChanged"/> event is emitted when metadata changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnMetadataChanged(MailKit.Metadata)">
- <summary>
- Raise the metadata changed event.
- </summary>
- <remarks>
- Raises the metadata changed event.
- </remarks>
- <param name="metadata">The metadata that changed.</param>
- </member>
- <member name="E:MailKit.MailFolder.ModSeqChanged">
- <summary>
- Occurs when the mod-sequence changed on a message.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.ModSeqChanged"/> event is emitted when the mod-sequence for a message is changed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnModSeqChanged(MailKit.ModSeqChangedEventArgs)">
- <summary>
- Raise the message mod-sequence changed event.
- </summary>
- <remarks>
- Raises the message mod-sequence changed event.
- </remarks>
- <param name="args">The mod-sequence changed event args.</param>
- </member>
- <member name="E:MailKit.MailFolder.HighestModSeqChanged">
- <summary>
- Occurs when the highest mod-sequence changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.HighestModSeqChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.HighestModSeq"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnHighestModSeqChanged">
- <summary>
- Raise the highest mod-sequence changed event.
- </summary>
- <remarks>
- Raises the highest mod-sequence changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.UidNextChanged">
- <summary>
- Occurs when the next UID changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.UidNextChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.UidNext"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnUidNextChanged">
- <summary>
- Raise the next UID changed event.
- </summary>
- <remarks>
- Raises the next UID changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.UidValidityChanged">
- <summary>
- Occurs when the UID validity changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.UidValidityChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.UidValidity"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnUidValidityChanged">
- <summary>
- Raise the uid validity changed event.
- </summary>
- <remarks>
- Raises the uid validity changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.IdChanged">
- <summary>
- Occurs when the folder ID changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.IdChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Id"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnIdChanged">
- <summary>
- Raise the ID changed event.
- </summary>
- <remarks>
- Raises the ID changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.SizeChanged">
- <summary>
- Occurs when the folder size changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.SizeChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Size"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnSizeChanged">
- <summary>
- Raise the size changed event.
- </summary>
- <remarks>
- Raises the size changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.CountChanged">
- <summary>
- Occurs when the message count changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.CountChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Count"/> value changes.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- </member>
- <member name="M:MailKit.MailFolder.OnCountChanged">
- <summary>
- Raise the message count changed event.
- </summary>
- <remarks>
- Raises the message count changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.RecentChanged">
- <summary>
- Occurs when the recent message count changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.RecentChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Recent"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnRecentChanged">
- <summary>
- Raise the recent message count changed event.
- </summary>
- <remarks>
- Raises the recent message count changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.UnreadChanged">
- <summary>
- Occurs when the unread message count changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.UnreadChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Unread"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnUnreadChanged">
- <summary>
- Raise the unread message count changed event.
- </summary>
- <remarks>
- Raises the unread message count changed event.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.GetEnumerator">
- <summary>
- Get an enumerator for the messages in the folder.
- </summary>
- <remarks>
- Gets an enumerator for the messages in the folder.
- </remarks>
- <returns>The enumerator.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Get an enumerator for the messages in the folder.
- </summary>
- <remarks>
- Gets an enumerator for the messages in the folder.
- </remarks>
- <returns>The enumerator.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MailFolder"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MailFolder"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MailFolder"/>.</returns>
- </member>
- <member name="T:MailKit.MailService">
- <summary>
- An abstract mail service implementation.
- </summary>
- <remarks>
- An abstract mail service implementation.
- </remarks>
- </member>
- <member name="M:MailKit.MailService.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MailService"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.MailService"/> class.
- </remarks>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.MailService.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MailService"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.MailService"/> class.
- </remarks>
- </member>
- <member name="M:MailKit.MailService.Finalize">
- <summary>
- Releases unmanaged resources and performs other cleanup operations before the
- <see cref="T:MailKit.MailService"/> is reclaimed by garbage collection.
- </summary>
- <remarks>
- Releases unmanaged resources and performs other cleanup operations before the
- <see cref="T:MailKit.MailService"/> is reclaimed by garbage collection.
- </remarks>
- </member>
- <member name="P:MailKit.MailService.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the service.
- </summary>
- <remarks>
- <para>Gets an object that can be used to synchronize access to the service.</para>
- </remarks>
- <value>The sync root.</value>
- </member>
- <member name="P:MailKit.MailService.Protocol">
- <summary>
- Gets the protocol supported by the message service.
- </summary>
- <remarks>
- Gets the protocol supported by the message service.
- </remarks>
- <value>The protocol.</value>
- </member>
- <member name="P:MailKit.MailService.ProtocolLogger">
- <summary>
- Get the protocol logger.
- </summary>
- <remarks>
- Gets the protocol logger.
- </remarks>
- <value>The protocol logger.</value>
- </member>
- <member name="P:MailKit.MailService.SslProtocols">
- <summary>
- Gets or sets the SSL and TLS protocol versions that the client is allowed to use.
- </summary>
- <remarks>
- <para>Gets or sets the SSL and TLS protocol versions that the client is allowed to use.</para>
- <para>By default, MailKit initializes this value to support only TLS v1.1 and greater and
- does not support TLS v1.0 or any version of SSL due to those protocols no longer being considered
- secure.</para>
- <para>This property should be set before calling any of the
- <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> methods.</para>
- </remarks>
- <value>The SSL and TLS protocol versions that are supported.</value>
- </member>
- <member name="P:MailKit.MailService.ClientCertificates">
- <summary>
- Gets or sets the client SSL certificates.
- </summary>
- <remarks>
- <para>Some servers may require the client SSL certificates in order
- to allow the user to connect.</para>
- <para>This property should be set before calling any of the
- <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> methods.</para>
- </remarks>
- <value>The client SSL certificates.</value>
- </member>
- <member name="P:MailKit.MailService.CheckCertificateRevocation">
- <summary>
- Get or set whether connecting via SSL/TLS should check certificate revocation.
- </summary>
- <remarks>
- <para>Gets or sets whether connecting via SSL/TLS should check certificate revocation.</para>
- <para>Normally, the value of this property should be set to <c>true</c> (the default) for security
- reasons, but there are times when it may be necessary to set it to <c>false</c>.</para>
- <para>For example, most Certificate Authorities are probably pretty good at keeping their CRL and/or
- OCSP servers up 24/7, but occasionally they do go down or are otherwise unreachable due to other
- network problems between the client and the Certificate Authority. When this happens, it becomes
- impossible to check the revocation status of one or more of the certificates in the chain
- resulting in an <see cref="T:MailKit.Security.SslHandshakeException"/> being thrown in the
- <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> method. If this becomes a problem,
- it may become desirable to set <see cref="P:MailKit.MailService.CheckCertificateRevocation"/> to <c>false</c>.</para>
- </remarks>
- <value><c>true</c> if certificate revocation should be checked; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailService.ServerCertificateValidationCallback">
- <summary>
- Get or sets a callback function to validate the server certificate.
- </summary>
- <remarks>
- <para>Gets or sets a callback function to validate the server certificate.</para>
- <para>This property should be set before calling any of the
- <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> methods.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SslCertificateValidation.cs"/>
- </example>
- <value>The server certificate validation callback function.</value>
- </member>
- <member name="P:MailKit.MailService.LocalEndPoint">
- <summary>
- Get or set the local IP end point to use when connecting to the remote host.
- </summary>
- <remarks>
- Gets or sets the local IP end point to use when connecting to the remote host.
- </remarks>
- <value>The local IP end point or <c>null</c> to use the default end point.</value>
- </member>
- <member name="P:MailKit.MailService.ProxyClient">
- <summary>
- Get or set the proxy client to use when connecting to a remote host.
- </summary>
- <remarks>
- Gets or sets the proxy client to use when connecting to a remote host via any of the
- <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> methods.
- </remarks>
- <value>The proxy client.</value>
- </member>
- <member name="P:MailKit.MailService.AuthenticationMechanisms">
- <summary>
- Gets the authentication mechanisms supported by the mail server.
- </summary>
- <remarks>
- The authentication mechanisms are queried as part of the
- <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> method.
- </remarks>
- <value>The authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.MailService.IsConnected">
- <summary>
- Gets whether or not the client is currently connected to an mail server.
- </summary>
- <remarks>
- <para>The <see cref="P:MailKit.MailService.IsConnected"/> state is set to <c>true</c> immediately after
- one of the <a href="Overload_MailKit_MailService_Connect.htm">Connect</a>
- methods succeeds and is not set back to <c>false</c> until either the client
- is disconnected via <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until a
- <see cref="T:MailKit.ProtocolException"/> is thrown while attempting to read or write to
- the underlying network socket.</para>
- <para>When an <see cref="T:MailKit.ProtocolException"/> is caught, the connection state of the
- <see cref="T:MailKit.MailService"/> should be checked before continuing.</para>
- </remarks>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailService.IsSecure">
- <summary>
- Get whether or not the connection is secure (typically via SSL or TLS).
- </summary>
- <remarks>
- Gets whether or not the connection is secure (typically via SSL or TLS).
- </remarks>
- <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailService.IsAuthenticated">
- <summary>
- Get whether or not the client is currently authenticated with the mail server.
- </summary>
- <remarks>
- <para>Gets whether or not the client is currently authenticated with the mail server.</para>
- <para>To authenticate with the mail server, use one of the
- <a href="Overload_MailKit_MailService_Authenticate.htm">Authenticate</a> methods
- or any of the Async alternatives.</para>
- </remarks>
- <value><c>true</c> if the client is authenticated; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailService.Timeout">
- <summary>
- Gets or sets the timeout for network streaming operations, in milliseconds.
- </summary>
- <remarks>
- Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
- and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
- </remarks>
- <value>The timeout in milliseconds.</value>
- </member>
- <!-- Badly formed XML comment ignored for member "M:MailKit.MailService.DefaultServerCertificateValidationCallback(System.Object,System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Cryptography.X509Certificates.X509Chain,System.Net.Security.SslPolicyErrors)" -->
- <member name="M:MailKit.MailService.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server.
- </summary>
- <remarks>
- Establishes a connection to the specified mail server.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server.
- </summary>
- <remarks>
- Asynchronously establishes a connection to the specified mail server.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server using the provided socket.
- </summary>
- <remarks>
- <para>Establish a connection to the specified mail server using the provided socket.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.MailService.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server using the provided socket.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server using the provided socket.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server using the provided stream.
- </summary>
- <remarks>
- <para>Establish a connection to the specified mail server using the provided stream.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.MailService.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server using the provided stream.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server using the provided stream.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Connect(System.Uri,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server.
- </summary>
- <remarks>
- Establishes a connection to the specified mail server.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessageUri"/>
- </example>
- <param name="uri">The server URI.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="uri"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="uri"/> is not an absolute URI.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.ConnectAsync(System.Uri,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server.
- </summary>
- <remarks>
- Asynchronously establishes a connection to the specified mail server.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uri">The server URI.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="uri"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="uri"/> is not an absolute URI.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Connect(System.String,System.Int32,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified mail server.</para>
- <note type="note">
- <para>The <paramref name="useSsl"/> argument only controls whether or
- not the client makes an SSL-wrapped connection. In other words, even if the
- <paramref name="useSsl"/> parameter is <c>false</c>, SSL/TLS may still be used if
- the mail server supports the STARTTLS extension.</para>
- <para>To disable all use of SSL/TLS, use the
- <see cref="M:MailKit.MailService.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)"/>
- overload with a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.None">SecureSocketOptions.None</see>
- instead.</para>
- </note>
- </remarks>
- <param name="host">The host to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="useSsl"><value>true</value> if the client should make an SSL-wrapped connection to the server; otherwise, <value>false</value>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is out of range (<value>0</value> to <value>65535</value>, inclusive).
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.ConnectAsync(System.String,System.Int32,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server.</para>
- <note type="note">
- <para>The <paramref name="useSsl"/> argument only controls whether or
- not the client makes an SSL-wrapped connection. In other words, even if the
- <paramref name="useSsl"/> parameter is <c>false</c>, SSL/TLS may still be used if
- the mail server supports the STARTTLS extension.</para>
- <para>To disable all use of SSL/TLS, use the
- <see cref="M:MailKit.MailService.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)"/>
- overload with a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.None">SecureSocketOptions.None</see>
- instead.</para>
- </note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="useSsl"><value>true</value> if the client should make an SSL-wrapped connection to the server; otherwise, <value>false</value>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is out of range (<value>0</value> to <value>65535</value>, inclusive).
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Authenticate(System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.AuthenticateAsync(System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Authenticate(System.Text.Encoding,System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.AuthenticateAsync(System.Text.Encoding,System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Authenticate(System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.AuthenticateAsync(System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="quit">If set to <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.MailService.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="quit">If set to <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.MailService.NoOp(System.Threading.CancellationToken)">
- <summary>
- Ping the mail server to keep the connection alive.
- </summary>
- <remarks>
- Mail servers, if left idle for too long, will automatically drop the connection.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>The <see cref="T:MailKit.MailService"/> is not connected.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.MailService"/> is not authenticated.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.MailService.NoOpAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously ping the mail server to keep the connection alive.
- </summary>
- <remarks>
- Mail servers, if left idle for too long, will automatically drop the connection.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>The <see cref="T:MailKit.MailService"/> is not connected.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.MailService"/> is not authenticated.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="E:MailKit.MailService.Connected">
- <summary>
- Occurs when the client has been successfully connected.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailService.Connected"/> event is raised when the client
- successfully connects to the mail server.
- </remarks>
- </member>
- <member name="M:MailKit.MailService.OnConnected(System.String,System.Int32,MailKit.Security.SecureSocketOptions)">
- <summary>
- Raise the connected event.
- </summary>
- <remarks>
- Raises the connected event.
- </remarks>
- <param name="host">The name of the host that the client connected to.</param>
- <param name="port">The port that the client connected to on the remote host.</param>
- <param name="options">The SSL/TLS options that were used when connecting.</param>
- </member>
- <member name="E:MailKit.MailService.Disconnected">
- <summary>
- Occurs when the client gets disconnected.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailService.Disconnected"/> event is raised whenever the client
- gets disconnected.
- </remarks>
- </member>
- <member name="M:MailKit.MailService.OnDisconnected(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Boolean)">
- <summary>
- Raise the disconnected event.
- </summary>
- <remarks>
- Raises the disconnected event.
- </remarks>
- <param name="host">The name of the host that the client was connected to.</param>
- <param name="port">The port that the client was connected to on the remote host.</param>
- <param name="options">The SSL/TLS options that were used by the client.</param>
- <param name="requested"><c>true</c> if the disconnect was explicitly requested; otherwise, <c>false</c>.</param>
- </member>
- <member name="E:MailKit.MailService.Authenticated">
- <summary>
- Occurs when the client has been successfully authenticated.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailService.Authenticated"/> event is raised whenever the client
- has been authenticated.
- </remarks>
- </member>
- <member name="M:MailKit.MailService.OnAuthenticated(System.String)">
- <summary>
- Raise the authenticated event.
- </summary>
- <remarks>
- Raises the authenticated event.
- </remarks>
- <param name="message">The notification sent by the server when the client successfully authenticates.</param>
- </member>
- <member name="M:MailKit.MailService.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.MailService"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.MailService"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="M:MailKit.MailService.Dispose">
- <summary>
- Releases all resource used by the <see cref="T:MailKit.MailService"/> object.
- </summary>
- <remarks>Call <see cref="M:MailKit.MailService.Dispose"/> when you are finished using the <see cref="T:MailKit.MailService"/>. The
- <see cref="M:MailKit.MailService.Dispose"/> method leaves the <see cref="T:MailKit.MailService"/> in an unusable state. After
- calling <see cref="M:MailKit.MailService.Dispose"/>, you must release all references to the <see cref="T:MailKit.MailService"/> so
- the garbage collector can reclaim the memory that the <see cref="T:MailKit.MailService"/> was occupying.</remarks>
- </member>
- <member name="T:MailKit.MailSpool">
- <summary>
- An abstract mail spool implementation.
- </summary>
- <remarks>
- An abstract mail spool implementation.
- </remarks>
- </member>
- <member name="M:MailKit.MailSpool.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MailSpool"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.MailSpool"/> class.
- </remarks>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.MailSpool.Count">
- <summary>
- Get the number of messages available in the message spool.
- </summary>
- <remarks>
- <para>Gets the number of messages available in the message spool.</para>
- <para>Once authenticated, the <see cref="P:MailKit.MailSpool.Count"/> property will be set
- to the number of available messages in the spool.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <value>The message count.</value>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- </member>
- <member name="P:MailKit.MailSpool.SupportsUids">
- <summary>
- Get whether or not the service supports referencing messages by UIDs.
- </summary>
- <remarks>
- <para>Not all servers support referencing messages by UID, so this property should
- be checked before using <see cref="M:MailKit.MailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/>
- and <see cref="M:MailKit.MailSpool.GetMessageUids(System.Threading.CancellationToken)"/>.</para>
- <para>If the server does not support UIDs, then all methods that take UID arguments
- along with <see cref="M:MailKit.MailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/> and
- <see cref="M:MailKit.MailSpool.GetMessageUids(System.Threading.CancellationToken)"/> will fail.</para>
- </remarks>
- <value><c>true</c> if supports uids; otherwise, <c>false</c>.</value>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageCount(System.Threading.CancellationToken)">
- <summary>
- Get the message count.
- </summary>
- <remarks>
- Gets the message count.
- </remarks>
- <returns>The message count.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageCountAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the message count.
- </summary>
- <remarks>
- Asynchronously gets the message count.
- </remarks>
- <returns>The message count.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the UID of the message at the specified index.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.MailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message UID.</returns>
- <param name="index">The message index.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail spool does not support UIDs.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageUidAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the UID of the message at the specified index.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.MailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message UID.</returns>
- <param name="index">The message index.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail spool does not support UIDs.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageUids(System.Threading.CancellationToken)">
- <summary>
- Get the full list of available message UIDs.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.MailSpool.SupportsUids"/> property.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadNewMessages"/>
- </example>
- <returns>The message uids.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail spool does not support UIDs.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageUidsAsync(System.Threading.CancellationToken)">
- <summary>
- Get the full list of available message UIDs.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.MailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message uids.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail spool does not support UIDs.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageSize(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the size of the specified message, in bytes.
- </summary>
- <remarks>
- Gets the size of the specified message, in bytes.
- </remarks>
- <returns>The message size, in bytes.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageSizeAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the size of the specified message, in bytes.
- </summary>
- <remarks>
- Asynchronously gets the size of the specified message, in bytes.
- </remarks>
- <returns>The message size, in bytes.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageSizes(System.Threading.CancellationToken)">
- <summary>
- Get the sizes for all available messages, in bytes.
- </summary>
- <remarks>
- Gets the sizes for all available messages, in bytes.
- </remarks>
- <returns>The message sizes, in bytes.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageSizesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the sizes for all available messages, in bytes.
- </summary>
- <remarks>
- Asynchronously gets the sizes for all available messages, in bytes.
- </remarks>
- <returns>The message sizes, in bytes.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers for the specified message.
- </summary>
- <remarks>
- Gets the headers for the specified message.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageHeadersAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers for the specified message.
- </summary>
- <remarks>
- Asynchronously gets the headers for the specified message.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageHeaders(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Get the headers for the specified messages.
- </summary>
- <remarks>
- Gets the headers for the specified messages.
- </remarks>
- <returns>The headers for the specified messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageHeadersAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers for the specified messages.
- </summary>
- <remarks>
- Asynchronously gets the headers for the specified messages.
- </remarks>
- <returns>The headers for the specified messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageHeaders(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers of the messages within the specified range.
- </summary>
- <remarks>
- Gets the headers of the messages within the specified range.
- </remarks>
- <returns>The headers of the messages within the specified range.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageHeadersAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers of the messages within the specified range.
- </summary>
- <remarks>
- Gets the headers of the messages within the specified range.
- </remarks>
- <returns>The headers of the messages within the specified range.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message at the specified index.
- </summary>
- <remarks>
- Gets the message at the specified index.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message at the specified index.
- </summary>
- <remarks>
- Asynchronously gets the message at the specified index.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the messages at the specified indexes.
- </summary>
- <remarks>
- Get the messages at the specified indexes.
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the messages at the specified indexes.
- </summary>
- <remarks>
- Asynchronously get the messages at the specified indexes.
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessages(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the messages within the specified range.
- </summary>
- <remarks>
- Gets the messages within the specified range.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
- </example>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the messages within the specified range.
- </summary>
- <remarks>
- Asynchronously gets the messages within the specified range.
- </remarks>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header stream at the specified index.
- </summary>
- <remarks>
- Gets the message or header stream at the specified index.
- </remarks>
- <returns>The message or header stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetStreamAsync(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header stream at the specified index.
- </summary>
- <remarks>
- Asynchronously gets the message or header stream at the specified index.
- </remarks>
- <returns>The message or header stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetStreams(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header streams at the specified indexes.
- </summary>
- <remarks>
- <para>Get the message or header streams at the specified indexes.</para>
- <para>If the mail server supports pipelining, this method will likely be more
- efficient than using <see cref="M:MailKit.MailSpool.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for
- each message because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header streams at the specified indexes.
- </summary>
- <remarks>
- Asynchronously get the message or header streams at the specified indexes.
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetStreams(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header streams within the specified range.
- </summary>
- <remarks>
- <para>Gets the message or header streams within the specified range.</para>
- <para>If the mail server supports pipelining, this method will likely be more
- efficient than using <see cref="M:MailKit.MailSpool.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for
- each message because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="startIndex">The index of the first stream to get.</param>
- <param name="count">The number of streams to get.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetStreamsAsync(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header streams within the specified range.
- </summary>
- <remarks>
- Asynchronously gets the message or header streams within the specified range.
- </remarks>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first stream to get.</param>
- <param name="count">The number of streams to get.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteMessage(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Mark the specified message for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteMessageAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified message for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Mark the specified messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteMessages(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Mark the specified range of messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
- </example>
- <param name="startIndex">The index of the first message to mark for deletion.</param>
- <param name="count">The number of messages to mark for deletion.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified range of messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="startIndex">The index of the first message to mark for deletion.</param>
- <param name="count">The number of messages to mark for deletion.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteAllMessages(System.Threading.CancellationToken)">
- <summary>
- Mark all messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteAllMessagesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark all messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.Reset(System.Threading.CancellationToken)">
- <summary>
- Reset the state of all messages marked for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.ResetAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously reset the state of all messages marked for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetEnumerator">
- <summary>
- Get an enumerator for the messages in the folder.
- </summary>
- <remarks>
- Gets an enumerator for the messages in the folder.
- </remarks>
- <returns>The enumerator.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- A command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Get an enumerator for the messages in the folder.
- </summary>
- <remarks>
- Gets an enumerator for the messages in the folder.
- </remarks>
- <returns>The enumerator.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- A command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="T:MailKit.MailStore">
- <summary>
- An abstract mail store implementation.
- </summary>
- <remarks>
- An abstract mail store implementation.
- </remarks>
- </member>
- <member name="M:MailKit.MailStore.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MailStore"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.MailStore"/> class.
- </remarks>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.MailStore.PersonalNamespaces">
- <summary>
- Gets the personal namespaces.
- </summary>
- <remarks>
- The personal folder namespaces contain a user's personal mailbox folders.
- </remarks>
- <value>The personal namespaces.</value>
- </member>
- <member name="P:MailKit.MailStore.SharedNamespaces">
- <summary>
- Gets the shared namespaces.
- </summary>
- <remarks>
- The shared folder namespaces contain mailbox folders that are shared with the user.
- </remarks>
- <value>The shared namespaces.</value>
- </member>
- <member name="P:MailKit.MailStore.OtherNamespaces">
- <summary>
- Gets the other namespaces.
- </summary>
- <remarks>
- The other folder namespaces contain other mailbox folders.
- </remarks>
- <value>The other namespaces.</value>
- </member>
- <member name="P:MailKit.MailStore.SupportsQuotas">
- <summary>
- Get whether or not the mail store supports quotas.
- </summary>
- <remarks>
- Gets whether or not the mail store supports quotas.
- </remarks>
- <value><c>true</c> if the mail store supports quotas; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailStore.ThreadingAlgorithms">
- <summary>
- Get the threading algorithms supported by the mail store.
- </summary>
- <remarks>
- The threading algorithms are queried as part of the
- <a href="Overload_MailKit_MailStore_Connect.htm">Connect</a>
- and <a href="Overload_MailKit_MailStore_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The supported threading algorithms.</value>
- </member>
- <member name="P:MailKit.MailStore.Inbox">
- <summary>
- Get the Inbox folder.
- </summary>
- <remarks>
- <para>The Inbox folder is the default folder and always exists on the mail store.</para>
- <note type="note">This property will only be available after the client has been authenticated.</note>
- </remarks>
- <value>The Inbox folder.</value>
- </member>
- <member name="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)">
- <summary>
- Enable the quick resynchronization feature.
- </summary>
- <remarks>
- <para>Enables quick resynchronization when a folder is opened using the
- <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
- method.</para>
- <para>If this feature is enabled, the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is replaced
- with the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event.</para>
- <para>This method needs to be called immediately after calling one of the
- <a href="Overload_MailKit_MailService_Authenticate.htm">Authenticate</a> methods, before
- opening any folders.</para>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Quick resynchronization needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quick resynchronization.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.EnableQuickResyncAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable the quick resynchronization feature.
- </summary>
- <remarks>
- <para>Enables quick resynchronization when a folder is opened using the
- <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
- method.</para>
- <para>If this feature is enabled, the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is replaced
- with the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event.</para>
- <para>This method needs to be called immediately after calling one of the
- <a href="Overload_MailKit_MailService_Authenticate.htm">Authenticate</a> methods, before
- opening any folders.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Quick resynchronization needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quick resynchronization.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFolder(MailKit.SpecialFolder)">
- <summary>
- Get the specified special folder.
- </summary>
- <remarks>
- Not all mail stores support special folders. Each implementation
- should provide a way to determine if special folders are supported.
- </remarks>
- <returns>The folder if available; otherwise <c>null</c>.</returns>
- <param name="folder">The type of special folder.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="folder"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFolder(MailKit.FolderNamespace)">
- <summary>
- Get the folder for the specified namespace.
- </summary>
- <remarks>
- Gets the folder for the specified namespace.
- </remarks>
- <returns>The folder.</returns>
- <param name="namespace">The namespace.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFolders(MailKit.FolderNamespace,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFoldersAsync(MailKit.FolderNamespace,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Asynchronously gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFolders(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFoldersAsync(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Asynchronously gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFolder(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the folder for the specified path.
- </summary>
- <remarks>
- Gets the folder for the specified path.
- </remarks>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFolderAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the folder for the specified path.
- </summary>
- <remarks>
- Asynchronously gets the folder for the specified path.
- </remarks>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetMetadata(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="tags"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetMetadataAsync(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="tags"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Sets the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the specified metadata.
- </summary>
- <remarks>
- Asynchronously sets the specified metadata.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="E:MailKit.MailStore.Alert">
- <summary>
- Occurs when a remote message store receives an alert message from the server.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailStore.Alert"/> event is raised whenever the mail server sends an
- alert message.
- </remarks>
- </member>
- <member name="M:MailKit.MailStore.OnAlert(System.String)">
- <summary>
- Raise the alert event.
- </summary>
- <remarks>
- Raises the alert event.
- </remarks>
- <param name="message">The alert message.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- </member>
- <member name="E:MailKit.MailStore.FolderCreated">
- <summary>
- Occurs when a folder is created.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailStore.FolderCreated"/> event is emitted when a new folder is created.
- </remarks>
- </member>
- <member name="M:MailKit.MailStore.OnFolderCreated(MailKit.IMailFolder)">
- <summary>
- Raise the folder created event.
- </summary>
- <remarks>
- Raises the folder created event.
- </remarks>
- <param name="folder">The folder that was just created.</param>
- </member>
- <member name="E:MailKit.MailStore.MetadataChanged">
- <summary>
- Occurs when metadata changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailStore.MetadataChanged"/> event is emitted when metadata changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailStore.OnMetadataChanged(MailKit.Metadata)">
- <summary>
- Raise the metadata changed event.
- </summary>
- <remarks>
- Raises the metadata changed event.
- </remarks>
- <param name="metadata">The metadata that changed.</param>
- </member>
- <member name="T:MailKit.MailTransport">
- <summary>
- An abstract mail transport implementation.
- </summary>
- <remarks>
- An abstract mail transport implementation.
- </remarks>
- </member>
- <member name="M:MailKit.MailTransport.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MailTransport"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.MailTransport"/> class.
- </remarks>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.Send(MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message.
- </summary>
- <remarks>
- <para>Sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.SendAsync(MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message.
- </summary>
- <remarks>
- <para>Asynchronously sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.Send(MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Sends the specified message using the supplied sender and recipients.
- </remarks>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="sender"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="recipients"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.SendAsync(MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Asynchronously sends the specified message using the supplied sender and recipients.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="sender"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="recipients"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message.
- </summary>
- <remarks>
- <para>Sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessageWithOptions"/>
- </example>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>Internationalized formatting was requested but is not supported by the transport.</para>
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message.
- </summary>
- <remarks>
- <para>Asynchronously sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>Internationalized formatting was requested but is not supported by the transport.</para>
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Sends the specified message using the supplied sender and recipients.
- </remarks>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="sender"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="recipients"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>Internationalized formatting was requested but is not supported by the transport.</para>
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Asynchronously sends the specified message using the supplied sender and recipients.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="sender"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="recipients"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>Internationalized formatting was requested but is not supported by the transport.</para>
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="E:MailKit.MailTransport.MessageSent">
- <summary>
- Occurs when a message is successfully sent via the transport.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailTransport.MessageSent"/> event will be emitted each time a message is successfully sent.
- </remarks>
- </member>
- <member name="M:MailKit.MailTransport.OnMessageSent(MailKit.MessageSentEventArgs)">
- <summary>
- Raise the message sent event.
- </summary>
- <remarks>
- Raises the message sent event.
- </remarks>
- <param name="e">The message sent event args.</param>
- </member>
- <member name="T:MailKit.MessageEventArgs">
- <summary>
- Event args used when the state of a message changes.
- </summary>
- <remarks>
- Event args used when the state of a message changes.
- </remarks>
- </member>
- <member name="M:MailKit.MessageEventArgs.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageEventArgs.#ctor(System.Int32,MailKit.UniqueId)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="P:MailKit.MessageEventArgs.Index">
- <summary>
- Gets the index of the message that changed.
- </summary>
- <remarks>
- Gets the index of the message that changed.
- </remarks>
- <value>The index of the message.</value>
- </member>
- <member name="P:MailKit.MessageEventArgs.UniqueId">
- <summary>
- Gets the unique ID of the message that changed, if available.
- </summary>
- <remarks>
- Gets the unique ID of the message that changed, if available.
- </remarks>
- <value>The unique ID of the message.</value>
- </member>
- <member name="T:MailKit.MessageFlags">
- <summary>
- An enumeration of message flags.
- </summary>
- <remarks>
- An enumeration of message flags.
- </remarks>
- </member>
- <member name="F:MailKit.MessageFlags.None">
- <summary>
- No message flags are set.
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.Seen">
- <summary>
- The message has been read.
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.Answered">
- <summary>
- The message has been answered (replied to).
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.Flagged">
- <summary>
- The message has been flagged for importance.
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.Deleted">
- <summary>
- The message has been marked for deletion.
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.Draft">
- <summary>
- The message is marked as a draft.
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.Recent">
- <summary>
- The message has just recently arrived in the folder.
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.UserDefined">
- <summary>
- User-defined flags are allowed by the folder.
- </summary>
- </member>
- <member name="T:MailKit.MessageFlagsChangedEventArgs">
- <summary>
- Event args for the <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> event.
- </summary>
- <remarks>
- Event args for the <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> event.
- </remarks>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.MessageFlags)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="flags">The message flags.</param>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="flags">The message flags.</param>
- <param name="keywords">The user-defined message flags.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keywords"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.MessageFlags,System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="flags">The message flags.</param>
- <param name="modseq">The modification sequence value.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="flags">The message flags.</param>
- <param name="keywords">The user-defined message flags.</param>
- <param name="modseq">The modification sequence value.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keywords"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,MailKit.MessageFlags)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="flags">The message flags.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="flags">The message flags.</param>
- <param name="keywords">The user-defined message flags.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keywords"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,MailKit.MessageFlags,System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="flags">The message flags.</param>
- <param name="modseq">The modification sequence value.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="flags">The message flags.</param>
- <param name="keywords">The user-defined message flags.</param>
- <param name="modseq">The modification sequence value.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keywords"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="P:MailKit.MessageFlagsChangedEventArgs.Flags">
- <summary>
- Gets the updated message flags.
- </summary>
- <remarks>
- Gets the updated message flags.
- </remarks>
- <value>The updated message flags.</value>
- </member>
- <member name="P:MailKit.MessageFlagsChangedEventArgs.Keywords">
- <summary>
- Gets the updated user-defined message flags.
- </summary>
- <remarks>
- Gets the updated user-defined message flags.
- </remarks>
- <value>The updated user-defined message flags.</value>
- </member>
- <member name="P:MailKit.MessageFlagsChangedEventArgs.UserFlags">
- <summary>
- Gets the updated user-defined message flags.
- </summary>
- <remarks>
- Gets the updated user-defined message flags.
- </remarks>
- <value>The updated user-defined message flags.</value>
- </member>
- <member name="P:MailKit.MessageFlagsChangedEventArgs.ModSeq">
- <summary>
- Gets the updated mod-sequence value of the message, if available.
- </summary>
- <remarks>
- Gets the updated mod-sequence value of the message, if available.
- </remarks>
- <value>The mod-sequence value.</value>
- </member>
- <member name="T:MailKit.MessageLabelsChangedEventArgs">
- <summary>
- Event args for the <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> event.
- </summary>
- <remarks>
- Event args for the <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> event.
- </remarks>
- </member>
- <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32,System.Collections.Generic.IList{System.String})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="labels">The message labels.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32,System.Collections.Generic.IList{System.String},System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="labels">The message labels.</param>
- <param name="modseq">The modification sequence value.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,System.Collections.Generic.IList{System.String})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="labels">The message labels.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="labels">The message labels.</param>
- <param name="modseq">The modification sequence value.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="P:MailKit.MessageLabelsChangedEventArgs.Labels">
- <summary>
- Gets the updated labels.
- </summary>
- <remarks>
- Gets the updated labels.
- </remarks>
- <value>The updated labels.</value>
- </member>
- <member name="P:MailKit.MessageLabelsChangedEventArgs.ModSeq">
- <summary>
- Gets the updated mod-sequence value of the message, if available.
- </summary>
- <remarks>
- Gets the updated mod-sequence value of the message, if available.
- </remarks>
- <value>The mod-sequence value.</value>
- </member>
- <member name="T:MailKit.MessageNotFoundException">
- <summary>
- The exception that is thrown when a message (or body part) could not be found.
- </summary>
- <remarks>
- This exception is thrown by methods such as
- <a href="Overload_MailKit_IMailFolder_GetMessage.htm">IMailFolder.GetMessage</a>,
- <a href="Overload_MailKit_IMailFolder_GetBodyPart.htm">IMailFolder.GetBodyPart</a>, or
- <a href="Overload_MailKit_IMailFolder_GetStream.htm">IMailFolder.GetStream</a>
- when the server's response does not contain the message, body part, or stream data requested.
- </remarks>
- </member>
- <member name="M:MailKit.MessageNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageNotFoundException"/> class.
- </summary>
- <remarks>
- Deserializes a <see cref="T:MailKit.MessageNotFoundException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.MessageNotFoundException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageNotFoundException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageNotFoundException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- <exception cref="T:System.ArgumentNullException">
- </exception>
- </member>
- <member name="M:MailKit.MessageNotFoundException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageNotFoundException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageNotFoundException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="T:MailKit.MessageSentEventArgs">
- <summary>
- Event args used when a message is successfully sent.
- </summary>
- <remarks>
- Event args used when message is successfully sent.
- </remarks>
- </member>
- <member name="M:MailKit.MessageSentEventArgs.#ctor(MimeKit.MimeMessage,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageSentEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageSentEventArgs"/>.
- </remarks>
- <param name="message">The message that was just sent.</param>
- <param name="response">The response from the server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="response"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.MessageSentEventArgs.Message">
- <summary>
- Get the message that was just sent.
- </summary>
- <remarks>
- Gets the message that was just sent.
- </remarks>
- <value>The message.</value>
- </member>
- <member name="P:MailKit.MessageSentEventArgs.Response">
- <summary>
- Get the server's response.
- </summary>
- <remarks>
- Gets the server's response.
- </remarks>
- <value>The response.</value>
- </member>
- <member name="T:MailKit.MessageSorter">
- <summary>
- Routines for sorting messages.
- </summary>
- <remarks>
- Routines for sorting messages.
- </remarks>
- </member>
- <member name="M:MailKit.MessageSorter.Sort``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IList{MailKit.Search.OrderBy})">
- <summary>
- Sorts the messages by the specified ordering.
- </summary>
- <remarks>
- Sorts the messages by the specified ordering.
- </remarks>
- <returns>The sorted messages.</returns>
- <typeparam name="T">The message items must implement the <see cref="T:MailKit.IMessageSummary"/> interface.</typeparam>
- <param name="messages">The messages to sort.</param>
- <param name="orderBy">The sort ordering.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="messages"/> contains one or more items that is missing information needed for sorting.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is an empty list.</para>
- </exception>
- </member>
- <member name="M:MailKit.MessageSorter.Sort``1(System.Collections.Generic.List{``0},System.Collections.Generic.IList{MailKit.Search.OrderBy})">
- <summary>
- Sorts the messages by the specified ordering.
- </summary>
- <remarks>
- Sorts the messages by the specified ordering.
- </remarks>
- <returns>The sorted messages.</returns>
- <typeparam name="T">The message items must implement the <see cref="T:MailKit.IMessageSummary"/> interface.</typeparam>
- <param name="messages">The messages to sort.</param>
- <param name="orderBy">The sort ordering.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="messages"/> contains one or more items that is missing information needed for sorting.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is an empty list.</para>
- </exception>
- </member>
- <member name="T:MailKit.MessageSummary">
- <summary>
- A summary of a message.
- </summary>
- <remarks>
- A <see cref="T:MailKit.MessageSummary"/> is returned by
- <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>.
- The properties of the <see cref="T:MailKit.MessageSummary"/> that will be available
- depend on the <see cref="T:MailKit.MessageSummaryItems"/> passed to the aformentioned method.
- </remarks>
- </member>
- <member name="M:MailKit.MessageSummary.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageSummary"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageSummary"/>.
- </remarks>
- <param name="index">The message index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is negative.
- </exception>
- </member>
- <member name="P:MailKit.MessageSummary.Fields">
- <summary>
- Get a bitmask of fields that have been populated.
- </summary>
- <remarks>
- Gets a bitmask of fields that have been populated.
- </remarks>
- <value>The fields that have been populated.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Body">
- <summary>
- Gets the body structure of the message, if available.
- </summary>
- <remarks>
- <para>The body will be one of <see cref="T:MailKit.BodyPartText"/>,
- <see cref="T:MailKit.BodyPartMessage"/>, <see cref="T:MailKit.BodyPartBasic"/>,
- or <see cref="T:MailKit.BodyPartMultipart"/>.</para>
- <para>This property will only be set if either the
- <see cref="F:MailKit.MessageSummaryItems.Body"/> flag or the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The body structure of the message.</value>
- </member>
- <member name="P:MailKit.MessageSummary.TextBody">
- <summary>
- Gets the text body part of the message if it exists.
- </summary>
- <remarks>
- <para>Gets the <c>text/plain</c> body part of the message.</para>
- <para>This property will only be usable if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <value>The text body if it exists; otherwise, <c>null</c>.</value>
- </member>
- <member name="P:MailKit.MessageSummary.HtmlBody">
- <summary>
- Gets the html body part of the message if it exists.
- </summary>
- <remarks>
- <para>Gets the <c>text/html</c> body part of the message.</para>
- <para>This property will only be usable if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The html body if it exists; otherwise, <c>null</c>.</value>
- </member>
- <member name="P:MailKit.MessageSummary.BodyParts">
- <summary>
- Gets the body parts of the message.
- </summary>
- <remarks>
- <para>Traverses over the <see cref="P:MailKit.MessageSummary.Body"/>, enumerating all of the
- <see cref="T:MailKit.BodyPartBasic"/> objects.</para>
- <para>This property will only be usable if either the
- <see cref="F:MailKit.MessageSummaryItems.Body"/> flag or the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The body parts.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Attachments">
- <summary>
- Gets the attachments.
- </summary>
- <remarks>
- <para>Traverses over the <see cref="P:MailKit.MessageSummary.Body"/>, enumerating all of the
- <see cref="T:MailKit.BodyPartBasic"/> objects that have a <c>Content-Disposition</c>
- header set to <c>"attachment"</c>.</para>
- <para>This property will only be usable if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <value>The attachments.</value>
- </member>
- <member name="P:MailKit.MessageSummary.PreviewText">
- <summary>
- Gets the preview text of the message.
- </summary>
- <remarks>
- <para>The preview text is a short snippet of the beginning of the message
- text, typically shown in a mail client's message list to provide the user
- with a sense of what the message is about.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.PreviewText"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The preview text.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Envelope">
- <summary>
- Gets the envelope of the message, if available.
- </summary>
- <remarks>
- <para>The envelope of a message contains information such as the
- date the message was sent, the subject of the message,
- the sender of the message, who the message was sent to,
- which message(s) the message may be in reply to,
- and the message id.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Envelope"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The envelope of the message.</value>
- </member>
- <member name="P:MailKit.MessageSummary.NormalizedSubject">
- <summary>
- Gets the normalized subject.
- </summary>
- <remarks>
- A normalized Subject header value where prefixes such as
- "Re:", "Re[#]:", etc have been pruned.
- </remarks>
- <value>The normalized subject.</value>
- </member>
- <member name="P:MailKit.MessageSummary.IsReply">
- <summary>
- Gets whether or not the message is a reply.
- </summary>
- <remarks>
- This value should be based on whether the message subject contained any "Re:" or "Fwd:" prefixes.
- </remarks>
- <value><c>true</c> if the message is a reply; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Date">
- <summary>
- Gets the Date header value.
- </summary>
- <remarks>
- Gets the Date header value. If the Date header is not present, the arrival date is used.
- If neither are known, <see cref="F:System.DateTimeOffset.MinValue"/> is returned.
- </remarks>
- <value>The date.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Flags">
- <summary>
- Gets the message flags, if available.
- </summary>
- <remarks>
- <para>Gets the message flags, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The message flags.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Keywords">
- <summary>
- Gets the user-defined message flags, if available.
- </summary>
- <remarks>
- <para>Gets the user-defined message flags, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The user-defined message flags.</value>
- </member>
- <member name="P:MailKit.MessageSummary.UserFlags">
- <summary>
- Gets the user-defined message flags, if available.
- </summary>
- <remarks>
- <para>Gets the user-defined message flags, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The user-defined message flags.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Annotations">
- <summary>
- Gets the message annotations, if available.
- </summary>
- <remarks>
- <para>Gets the message annotations, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Annotations"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The message annotations.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Headers">
- <summary>
- Gets the list of headers, if available.
- </summary>
- <remarks>
- <para>Gets the list of headers, if available.</para>
- <para>This property will only be set if <see cref="F:MailKit.MessageSummaryItems.Headers"/>
- is specified in a call to one of the
- <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods or specific headers are requested via a one of the Fetch or FetchAsync methods
- that accept list of specific headers to request for each message such as
- <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)"/>.
- </para>
- </remarks>
- <value>The list of headers.</value>
- </member>
- <member name="P:MailKit.MessageSummary.InternalDate">
- <summary>
- Gets the internal date of the message (i.e. the "received" date), if available.
- </summary>
- <remarks>
- <para>Gets the internal date of the message (i.e. the "received" date), if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.InternalDate"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The internal date of the message.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Size">
- <summary>
- Gets the size of the message, in bytes, if available.
- </summary>
- <remarks>
- <para>Gets the size of the message, in bytes, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Size"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The size of the message.</value>
- </member>
- <member name="P:MailKit.MessageSummary.ModSeq">
- <summary>
- Gets the mod-sequence value for the message, if available.
- </summary>
- <remarks>
- <para>Gets the mod-sequence value for the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.ModSeq"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The mod-sequence value.</value>
- </member>
- <member name="P:MailKit.MessageSummary.References">
- <summary>
- Gets the message-ids that the message references, if available.
- </summary>
- <remarks>
- <para>Gets the message-ids that the message references, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.References"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The references.</value>
- </member>
- <member name="P:MailKit.MessageSummary.EmailId">
- <summary>
- Get the globally unique identifier for the message, if available.
- </summary>
- <remarks>
- <para>Gets the globally unique identifier of the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.EmailId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- <note type="info">This property maps to the <c>EMAILID</c> value defined in the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The globally unique message identifier.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Id">
- <summary>
- Get the globally unique identifier for the message, if available.
- </summary>
- <remarks>
- <para>Gets the globally unique identifier of the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.EmailId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- <note type="info">This property maps to the <c>EMAILID</c> value defined in the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The globally unique message identifier.</value>
- </member>
- <member name="P:MailKit.MessageSummary.ThreadId">
- <summary>
- Get the globally unique thread identifier for the message, if available.
- </summary>
- <remarks>
- <para>Gets the globally unique thread identifier for the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.ThreadId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- <note type="info">This property maps to the <c>THREADID</c> value defined in the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The globally unique thread identifier.</value>
- </member>
- <member name="P:MailKit.MessageSummary.UniqueId">
- <summary>
- Gets the unique identifier of the message, if available.
- </summary>
- <remarks>
- <para>Gets the unique identifier of the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.UniqueId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The uid of the message.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Index">
- <summary>
- Gets the index of the message.
- </summary>
- <remarks>
- <para>Gets the index of the message.</para>
- <para>This property is always set.</para>
- </remarks>
- <value>The index of the message.</value>
- </member>
- <member name="P:MailKit.MessageSummary.GMailMessageId">
- <summary>
- Gets the GMail message identifier, if available.
- </summary>
- <remarks>
- <para>Gets the GMail message identifier, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.GMailMessageId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The GMail message identifier.</value>
- </member>
- <member name="P:MailKit.MessageSummary.GMailThreadId">
- <summary>
- Gets the GMail thread identifier, if available.
- </summary>
- <remarks>
- <para>Gets the GMail thread identifier, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.GMailThreadId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The GMail thread identifier.</value>
- </member>
- <member name="P:MailKit.MessageSummary.GMailLabels">
- <summary>
- Gets the list of GMail labels, if available.
- </summary>
- <remarks>
- <para>Gets the list of GMail labels, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.GMailLabels"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The GMail labels.</value>
- </member>
- <member name="T:MailKit.MessageSummaryFetchedEventArgs">
- <summary>
- Event args used when a message summary has been fetched from a folder.
- </summary>
- <remarks>
- Event args used when a message summary has been fetched from a folder.
- </remarks>
- </member>
- <member name="M:MailKit.MessageSummaryFetchedEventArgs.#ctor(MailKit.IMessageSummary)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageSummaryFetchedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageSummaryFetchedEventArgs"/>
- </remarks>
- <param name="message">The message summary.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.MessageSummaryFetchedEventArgs.Message">
- <summary>
- Get the message summary.
- </summary>
- <remarks>
- Gets the message summary.
- </remarks>
- <value>The message summary.</value>
- </member>
- <member name="T:MailKit.MessageSummaryItems">
- <summary>
- A bitfield of <see cref="T:MailKit.MessageSummary"/> fields.
- </summary>
- <remarks>
- <see cref="T:MailKit.MessageSummaryItems"/> are used to specify which properties
- of <see cref="T:MailKit.MessageSummary"/> should be populated by calls to
- <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>,
- <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>, or
- <see cref="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>.
- </remarks>
- </member>
- <member name="F:MailKit.MessageSummaryItems.None">
- <summary>
- Don't fetch any summary items.
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Annotations">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.Annotations"/>.</para>
- <para>Fetches all <c>ANNOATION</c> values as defined in
- <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Body">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.Body"/>.</para>
- <para>Fetches the <c>BODY</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- <note type="note">Unlike <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/>, <c>Body</c> will not populate the
- <see cref="P:MailKit.BodyPart.ContentType"/> parameters nor will it populate the
- <see cref="P:MailKit.BodyPartBasic.ContentDisposition"/>, <see cref="P:MailKit.BodyPartBasic.ContentLanguage"/>
- or <see cref="P:MailKit.BodyPartBasic.ContentLocation"/> properties of each <see cref="T:MailKit.BodyPartBasic"/>
- body part. This makes <c>Body</c> far less useful than <c>BodyStructure</c> especially when
- it is desirable to determine whether or not a body part is an attachment.</note>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.BodyStructure">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.Body"/> (but with more details than <see cref="F:MailKit.MessageSummaryItems.Body"/>).</para>
- <para>Fetches the <c>BODYSTRUCTURE</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- <note type="note">Unlike <see cref="F:MailKit.MessageSummaryItems.Body"/>, <c>BodyStructure</c> will also populate the
- <see cref="P:MailKit.BodyPart.ContentType"/> parameters as well as the
- <see cref="P:MailKit.BodyPartBasic.ContentDisposition"/>, <see cref="P:MailKit.BodyPartBasic.ContentLanguage"/>
- and <see cref="P:MailKit.BodyPartBasic.ContentLocation"/> properties of each <see cref="T:MailKit.BodyPartBasic"/>
- body part. The <c>Content-Disposition</c> information is especially important when trying to
- determine whether or not a body part is an attachment, for example.</note>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Envelope">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.Envelope"/>.</para>
- <para>Fetches the <c>ENVELOPE</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Flags">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.Flags"/>.</para>
- <para>Fetches the <c>FLAGS</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.InternalDate">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.InternalDate"/>.</para>
- <para>Fetches the <c>INTERNALDATE</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Size">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.Size"/>.</para>
- <para>Fetches the <c>RFC822.SIZE</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.ModSeq">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.ModSeq"/>.</para>
- <para>Fetches the <c>MODSEQ</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc4551">rfc4551</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.References">
- <summary>
- Fetch the <see cref="P:MailKit.IMessageSummary.References"/>.
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.UniqueId">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.UniqueId"/>.</para>
- <para>Fetches the <c>UID</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.EmailId">
- <summary>
- <para></para>Fetch the <see cref="P:MailKit.IMessageSummary.EmailId"/>.
- <para>Fetches the <c>EMAILID</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc8474">rfc8474</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Id">
- <summary>
- <para></para>Fetch the <see cref="P:MailKit.IMessageSummary.EmailId"/>.
- <para>Fetches the <c>EMAILID</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc8474">rfc8474</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.ThreadId">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.ThreadId"/>.</para>
- <para>Fetches the <c>THREADID</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc8474">rfc8474</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.GMailMessageId">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.GMailMessageId"/>.</para>
- <para>Fetches the <c>X-GM-MSGID</c> value as defined in Google's
- <a href="https://developers.google.com/gmail/imap/imap-extensions">IMAP extensions</a>
- documentation.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.GMailThreadId">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.GMailThreadId"/>.</para>
- <para>Fetches the <c>X-GM-THRID</c> value as defined in Google's
- <a href="https://developers.google.com/gmail/imap/imap-extensions">IMAP extensions</a>
- documentation.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.GMailLabels">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.GMailLabels"/>.</para>
- <para>Fetches the <c>X-GM-LABELS</c> value as defined in Google's
- <a href="https://developers.google.com/gmail/imap/imap-extensions">IMAP extensions</a>
- documentation.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Headers">
- <summary>
- <para>Fetch the the complete list of <see cref="P:MailKit.IMessageSummary.Headers"/> for each message.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.PreviewText">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.PreviewText"/>.</para>
- <note type="note">This property is quite expensive to calculate because it is not an
- item that is cached on the IMAP server. Instead, MailKit must download a hunk of the
- message body so that it can decode and parse it in order to generate a meaningful
- text snippet. This usually involves downloading the first 512 bytes for <c>text/plain</c>
- message bodies and the first 16 kilobytes for <c>text/html</c> message bodies. If a
- message contains both a <c>text/plain</c> body and a <c>text/html</c> body, then the
- <c>text/plain</c> content is used in order to reduce network traffic.</note>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.All">
- <summary>
- <para>A macro for fetching the <see cref="F:MailKit.MessageSummaryItems.Envelope"/>, <see cref="F:MailKit.MessageSummaryItems.Flags"/>,
- <see cref="F:MailKit.MessageSummaryItems.InternalDate"/>, and <see cref="F:MailKit.MessageSummaryItems.Size"/> values.</para>
- <para>This macro maps to the equivalent <c>ALL</c> macro as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Fast">
- <summary>
- <para>A macro for fetching the <see cref="F:MailKit.MessageSummaryItems.Flags"/>, <see cref="F:MailKit.MessageSummaryItems.InternalDate"/>, and
- <see cref="F:MailKit.MessageSummaryItems.Size"/> values.</para>
- <para>This macro maps to the equivalent <c>FAST</c> macro as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Full">
- <summary>
- <para>A macro for fetching the <see cref="F:MailKit.MessageSummaryItems.Body"/>, <see cref="F:MailKit.MessageSummaryItems.Envelope"/>,
- <see cref="F:MailKit.MessageSummaryItems.Flags"/>, <see cref="F:MailKit.MessageSummaryItems.InternalDate"/>, and <see cref="F:MailKit.MessageSummaryItems.Size"/> values.</para>
- <para>This macro maps to the equivalent <c>FULL</c> macro as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="T:MailKit.MessagesVanishedEventArgs">
- <summary>
- Event args used when a message vanishes from a folder.
- </summary>
- <remarks>
- Event args used when a message vanishes from a folder.
- </remarks>
- </member>
- <member name="M:MailKit.MessagesVanishedEventArgs.#ctor(System.Collections.Generic.IList{MailKit.UniqueId},System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessagesVanishedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessagesVanishedEventArgs"/>.
- </remarks>
- <param name="uids">The list of unique identifiers.</param>
- <param name="earlier">If set to <c>true</c>, the messages vanished in the past as opposed to just now.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.MessagesVanishedEventArgs.UniqueIds">
- <summary>
- Gets the unique identifiers of the messages that vanished.
- </summary>
- <remarks>
- Gets the unique identifiers of the messages that vanished.
- </remarks>
- <value>The unique identifiers.</value>
- </member>
- <member name="P:MailKit.MessagesVanishedEventArgs.Earlier">
- <summary>
- Gets whether the messages vanished inthe past as opposed to just now.
- </summary>
- <remarks>
- Gets whether the messages vanished inthe past as opposed to just now.
- </remarks>
- <value><c>true</c> if the messages vanished earlier; otherwise, <c>false</c>.</value>
- </member>
- <member name="T:MailKit.MessageThread">
- <summary>
- A message thread.
- </summary>
- <remarks>
- A message thread.
- </remarks>
- </member>
- <member name="M:MailKit.MessageThread.#ctor(System.Nullable{MailKit.UniqueId})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageThread"/> class.
- </summary>
- <remarks>
- Creates a new message thread node.
- </remarks>
- <param name="uid">The unique identifier of the message.</param>
- </member>
- <member name="P:MailKit.MessageThread.UniqueId">
- <summary>
- Gets the unique identifier of the message.
- </summary>
- <remarks>
- The unique identifier may be <c>null</c> if the message is missing
- from the <see cref="T:MailKit.IMailFolder"/> or did not match the
- <see cref="T:MailKit.Search.SearchQuery"/>.
- </remarks>
- <value>The unique identifier.</value>
- </member>
- <member name="P:MailKit.MessageThread.Children">
- <summary>
- Gets the children.
- </summary>
- <remarks>
- Each child represents a reply to the message referenced by <see cref="P:MailKit.MessageThread.UniqueId"/>.
- </remarks>
- <value>The children.</value>
- </member>
- <member name="T:MailKit.MessageThreader">
- <summary>
- Threads messages according to the algorithms defined in rfc5256.
- </summary>
- <remarks>
- Threads messages according to the algorithms defined in rfc5256.
- </remarks>
- </member>
- <member name="M:MailKit.MessageThreader.Thread(System.Collections.Generic.IEnumerable{MailKit.IMessageSummary},MailKit.ThreadingAlgorithm)">
- <summary>
- Thread the messages according to the specified threading algorithm.
- </summary>
- <remarks>
- Thread the messages according to the specified threading algorithm.
- </remarks>
- <returns>The threaded messages.</returns>
- <param name="messages">The messages.</param>
- <param name="algorithm">The threading algorithm.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="messages"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not a valid threading algorithm.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="messages"/> contains one or more items that is missing information needed for threading.
- </exception>
- </member>
- <member name="M:MailKit.MessageThreader.Thread(System.Collections.Generic.IEnumerable{MailKit.IMessageSummary},MailKit.ThreadingAlgorithm,System.Collections.Generic.IList{MailKit.Search.OrderBy})">
- <summary>
- Threads the messages according to the specified threading algorithm
- and sorts the resulting threads by the specified ordering.
- </summary>
- <remarks>
- Threads the messages according to the specified threading algorithm
- and sorts the resulting threads by the specified ordering.
- </remarks>
- <returns>The threaded messages.</returns>
- <param name="messages">The messages.</param>
- <param name="algorithm">The threading algorithm.</param>
- <param name="orderBy">The requested sort ordering.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not a valid threading algorithm.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="messages"/> contains one or more items that is missing information needed for threading or sorting.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is an empty list.</para>
- </exception>
- </member>
- <member name="M:MailKit.MessageThreader.GetThreadableSubject(System.String,System.Int32@)">
- <summary>
- Gets the threadable subject.
- </summary>
- <remarks>
- Gets the threadable subject.
- </remarks>
- <returns>The threadable subject.</returns>
- <param name="subject">The Subject header value.</param>
- <param name="replyDepth">The reply depth.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="subject"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.Metadata">
- <summary>
- A metadata tag and value.
- </summary>
- <remarks>
- A metadata tag and value.
- </remarks>
- </member>
- <member name="M:MailKit.Metadata.#ctor(MailKit.MetadataTag,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Metadata"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Metadata"/>.
- </remarks>
- <param name="tag">The metadata tag.</param>
- <param name="value">The metadata value.</param>
- </member>
- <member name="P:MailKit.Metadata.Tag">
- <summary>
- Gets the metadata tag.
- </summary>
- <remarks>
- Gets the metadata tag.
- </remarks>
- <value>The metadata tag.</value>
- </member>
- <member name="P:MailKit.Metadata.Value">
- <summary>
- Gets the metadata value.
- </summary>
- <remarks>
- Gets the metadata value.
- </remarks>
- <value>The metadata value.</value>
- </member>
- <member name="T:MailKit.MetadataChangedEventArgs">
- <summary>
- Event args used when a metadata changes.
- </summary>
- <remarks>
- Event args used when a metadata changes.
- </remarks>
- </member>
- <member name="M:MailKit.MetadataChangedEventArgs.#ctor(MailKit.Metadata)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MetadataChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MetadataChangedEventArgs"/>.
- </remarks>
- <param name="metadata">The metadata that changed.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.MetadataChangedEventArgs.Metadata">
- <summary>
- Get the metadata that changed.
- </summary>
- <remarks>
- Gets the metadata that changed.
- </remarks>
- <value>The metadata.</value>
- </member>
- <member name="T:MailKit.MetadataCollection">
- <summary>
- A collection of metadata.
- </summary>
- <remarks>
- A collection of metadata.
- </remarks>
- </member>
- <member name="M:MailKit.MetadataCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MetadataCollection"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MetadataCollection"/>
- </remarks>
- </member>
- <member name="M:MailKit.MetadataCollection.#ctor(System.Collections.Generic.IEnumerable{MailKit.Metadata})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MetadataCollection"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MetadataCollection"/>.
- </remarks>
- <param name="collection">A collection of metadata.</param>
- </member>
- <member name="T:MailKit.MetadataOptions">
- <summary>
- A set of options to use when requesting metadata.
- </summary>
- <remarks>
- A set of options to use when requesting metadata.
- </remarks>
- </member>
- <member name="M:MailKit.MetadataOptions.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MetadataOptions"/> class.
- </summary>
- <remarks>
- Creates a new set of options to use when requesting metadata.
- </remarks>
- </member>
- <member name="P:MailKit.MetadataOptions.Depth">
- <summary>
- Get or set the depth.
- </summary>
- <remarks>
- <para>When the <see cref="P:MailKit.MetadataOptions.Depth"/> option is specified, it extends the list of metadata tag
- values returned by the GetMetadata() call. For each <see cref="T:MailKit.MetadataTag"/> specified in the
- the GetMetadata() call, the method returns the value of the specified metadata tag (if it exists),
- plus all metadata tags below the specified entry up to the specified depth.</para>
- <para>Three values are allowed for <see cref="P:MailKit.MetadataOptions.Depth"/>:</para>
- <para><c>0</c> - no entries below the specified metadata tag are returned.</para>
- <para><c>1</c> - only entries immediately below the specified metadata tag are returned.</para>
- <para><see cref="F:System.Int32.MaxValue"/> - all entries below the specified metadata tag are returned.</para>
- <para>Thus, a depth of <c>1</c> for a tag entry of <c>"/a"</c> will match <c>"/a"</c> as well as its children
- entries (e.g., <c>"/a/b"</c>), but will not match grandchildren entries (e.g., <c>"/a/b/c"</c>).</para>
- <para>If the Depth option is not specified, this is the same as specifying <c>0</c>.</para>
- </remarks>
- <value>The depth.</value>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="value"/> is out of range.
- </exception>
- </member>
- <member name="P:MailKit.MetadataOptions.MaxSize">
- <summary>
- Get or set the max size of the metadata tags to request.
- </summary>
- <remarks>
- When specified, the <see cref="P:MailKit.MetadataOptions.MaxSize"/> property is used to filter the metadata tags
- returned by the GetMetadata() call to only those with a value shorter than the max size
- specified.
- </remarks>
- <value>The size of the max.</value>
- </member>
- <member name="P:MailKit.MetadataOptions.LongEntries">
- <summary>
- Get the length of the longest metadata value.
- </summary>
- <remarks>
- If the <see cref="P:MailKit.MetadataOptions.MaxSize"/> property is specified, once the GetMetadata() call returns,
- the <see cref="P:MailKit.MetadataOptions.LongEntries"/> property will be set to the length of the longest metadata
- value that exceeded the <see cref="P:MailKit.MetadataOptions.MaxSize"/> limit, otherwise a value of <c>0</c> will
- be set.
- </remarks>
- <value>The length of the longest metadata value that exceeded the max size.</value>
- </member>
- <member name="T:MailKit.MetadataTag">
- <summary>
- A metadata tag.
- </summary>
- <remarks>
- A metadata tag.
- </remarks>
- </member>
- <member name="F:MailKit.MetadataTag.SharedAdmin">
- <summary>
- A metadata tag for specifying the contact information for the server administrator.
- </summary>
- <remarks>
- Used to get the contact information of the administrator on a
- <see cref="T:MailKit.IMailStore"/>.
- </remarks>
- </member>
- <member name="F:MailKit.MetadataTag.PrivateComment">
- <summary>
- A metadata tag for private comments.
- </summary>
- <remarks>
- Used to get or set a private comment on a <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="F:MailKit.MetadataTag.SharedComment">
- <summary>
- A metadata tag for shared comments.
- </summary>
- <remarks>
- Used to get or set a shared comment on a <see cref="T:MailKit.IMailStore"/>
- or <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="F:MailKit.MetadataTag.PrivateSpecialUse">
- <summary>
- A metadata tag for specifying the special use of a folder.
- </summary>
- <remarks>
- Used to get or set the special use of a <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="M:MailKit.MetadataTag.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MetadataTag"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MetadataTag"/>.
- </remarks>
- <param name="id">The metadata tag identifier.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="id"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="id"/> is an empty string.
- </exception>
- </member>
- <member name="P:MailKit.MetadataTag.Id">
- <summary>
- Get the metadata tag identifier.
- </summary>
- <remarks>
- Gets the metadata tag identifier.
- </remarks>
- <value>The metadata tag identifier.</value>
- </member>
- <member name="M:MailKit.MetadataTag.Equals(System.Object)">
- <summary>
- Determine whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.MetadataTag"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.MetadataTag"/>.
- </remarks>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.MetadataTag"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current
- <see cref="T:MailKit.MetadataTag"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.MetadataTag.GetHashCode">
- <summary>
- Serves as a hash function for a <see cref="T:MailKit.MetadataTag"/> object.
- </summary>
- <remarks>
- Serves as a hash function for a <see cref="T:MailKit.MetadataTag"/> object.
- </remarks>
- <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
- </member>
- <member name="M:MailKit.MetadataTag.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MetadataTag"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MetadataTag"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MetadataTag"/>.</returns>
- </member>
- <member name="T:MailKit.ModSeqChangedEventArgs">
- <summary>
- Event args for the <see cref="E:MailKit.IMailFolder.ModSeqChanged"/> event.
- </summary>
- <remarks>
- Event args for the <see cref="E:MailKit.IMailFolder.ModSeqChanged"/> event.
- </remarks>
- </member>
- <member name="M:MailKit.ModSeqChangedEventArgs.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ModSeqChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ModSeqChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- </member>
- <member name="M:MailKit.ModSeqChangedEventArgs.#ctor(System.Int32,System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="modseq">The modification sequence value.</param>
- </member>
- <member name="M:MailKit.ModSeqChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ModSeqChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ModSeqChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="modseq">The modification sequence value.</param>
- </member>
- <member name="P:MailKit.ModSeqChangedEventArgs.ModSeq">
- <summary>
- Gets the updated mod-sequence value of the message.
- </summary>
- <remarks>
- Gets the updated mod-sequence value of the message.
- </remarks>
- <value>The mod-sequence value.</value>
- </member>
- <member name="T:MailKit.NullProtocolLogger">
- <summary>
- A protocol logger that does not log to anywhere.
- </summary>
- <remarks>
- By default, the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>,
- <see cref="T:MailKit.Net.Pop3.Pop3Client"/>, and
- <see cref="T:MailKit.Net.Imap.ImapClient"/> all use a
- <see cref="T:MailKit.NullProtocolLogger"/>.
- </remarks>
- </member>
- <member name="M:MailKit.NullProtocolLogger.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.NullProtocolLogger"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.NullProtocolLogger"/>.
- </remarks>
- </member>
- <member name="M:MailKit.NullProtocolLogger.LogConnect(System.Uri)">
- <summary>
- Logs a connection to the specified URI.
- </summary>
- <remarks>
- This method does nothing.
- </remarks>
- <param name="uri">The URI.</param>
- </member>
- <member name="M:MailKit.NullProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Logs a sequence of bytes sent by the client.
- </summary>
- <remarks>
- This method does nothing.
- </remarks>
- <param name='buffer'>The buffer to log.</param>
- <param name='offset'>The offset of the first byte to log.</param>
- <param name='count'>The number of bytes to log.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.NullProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Logs a sequence of bytes sent by the server.
- </summary>
- <remarks>
- This method does nothing.
- </remarks>
- <param name='buffer'>The buffer to log.</param>
- <param name='offset'>The offset of the first byte to log.</param>
- <param name='count'>The number of bytes to log.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.NullProtocolLogger.Dispose">
- <summary>
- Releases all resource used by the <see cref="T:MailKit.NullProtocolLogger"/> object.
- </summary>
- <remarks>Call <see cref="M:MailKit.NullProtocolLogger.Dispose"/> when you are finished using the <see cref="T:MailKit.NullProtocolLogger"/>. The
- <see cref="M:MailKit.NullProtocolLogger.Dispose"/> method leaves the <see cref="T:MailKit.NullProtocolLogger"/> in an unusable state. After
- calling <see cref="M:MailKit.NullProtocolLogger.Dispose"/>, you must release all references to the <see cref="T:MailKit.NullProtocolLogger"/> so
- the garbage collector can reclaim the memory that the <see cref="T:MailKit.NullProtocolLogger"/> was occupying.</remarks>
- </member>
- <member name="T:MailKit.ProtocolException">
- <summary>
- The exception that is thrown when there is a protocol error.
- </summary>
- <remarks>
- <para>A <see cref="T:MailKit.ProtocolException"/> can be thrown by any of the various client
- methods in MailKit.</para>
- <para>Since many protocol exceptions are fatal, it is important to check whether
- or not the client is still connected using the <see cref="P:MailKit.IMailService.IsConnected"/>
- property when this exception is thrown.</para>
- </remarks>
- </member>
- <member name="M:MailKit.ProtocolException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ProtocolException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- </member>
- <member name="M:MailKit.ProtocolException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.ProtocolException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.ProtocolException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ProtocolException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.ProtocolLogger">
- <summary>
- A default protocol logger for logging the communication between a client and server.
- </summary>
- <remarks>
- A default protocol logger for logging the communication between a client and server.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ProtocolLogger" />
- </example>
- </member>
- <member name="M:MailKit.ProtocolLogger.#ctor(System.String,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ProtocolLogger"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ProtocolLogger"/> to log to a specified file. The file is created if it does not exist.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ProtocolLogger" />
- </example>
- <param name="fileName">The file name.</param>
- <param name="append"><c>true</c> if the file should be appended to; otherwise, <c>false</c>. Defaults to <c>true</c>.</param>
- </member>
- <member name="M:MailKit.ProtocolLogger.#ctor(System.IO.Stream,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ProtocolLogger"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ProtocolLogger"/> to log to a specified stream.
- </remarks>
- <param name="stream">The stream.</param>
- <param name="leaveOpen"><c>true</c> if the stream should be left open after the protocol logger is disposed.</param>
- </member>
- <member name="M:MailKit.ProtocolLogger.Finalize">
- <summary>
- Releases unmanaged resources and performs other cleanup operations before the <see cref="T:MailKit.ProtocolLogger"/>
- is reclaimed by garbage collection.
- </summary>
- <remarks>
- Releases unmanaged resources and performs other cleanup operations before the <see cref="T:MailKit.ProtocolLogger"/>
- is reclaimed by garbage collection.
- </remarks>
- </member>
- <member name="P:MailKit.ProtocolLogger.Stream">
- <summary>
- Get the log stream.
- </summary>
- <remarks>
- Gets the log stream.
- </remarks>
- <value>The log sstream.</value>
- </member>
- <member name="M:MailKit.ProtocolLogger.LogConnect(System.Uri)">
- <summary>
- Logs a connection to the specified URI.
- </summary>
- <remarks>
- Logs a connection to the specified URI.
- </remarks>
- <param name="uri">The URI.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uri"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The logger has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.ProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Logs a sequence of bytes sent by the client.
- </summary>
- <remarks>
- <para>Logs a sequence of bytes sent by the client.</para>
- <para><see cref="M:MailKit.ProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)"/> is called by the <see cref="T:MailKit.IMailService"/> upon every successful
- write operation to its underlying network stream, passing the exact same <paramref name="buffer"/>,
- <paramref name="offset"/>, and <paramref name="count"/> arguments to the logging function.</para>
- </remarks>
- <param name='buffer'>The buffer to log.</param>
- <param name='offset'>The offset of the first byte to log.</param>
- <param name='count'>The number of bytes to log.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The logger has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.ProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Logs a sequence of bytes sent by the server.
- </summary>
- <remarks>
- <para>Logs a sequence of bytes sent by the server.</para>
- <para><see cref="M:MailKit.ProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)"/> is called by the <see cref="T:MailKit.IMailService"/> upon every successful
- read of its underlying network stream with the exact buffer that was read.</para>
- </remarks>
- <param name='buffer'>The buffer to log.</param>
- <param name='offset'>The offset of the first byte to log.</param>
- <param name='count'>The number of bytes to log.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The logger has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.ProtocolLogger.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.ProtocolLogger"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.ProtocolLogger"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="M:MailKit.ProtocolLogger.Dispose">
- <summary>
- Releases all resource used by the <see cref="T:MailKit.ProtocolLogger"/> object.
- </summary>
- <remarks>Call <see cref="M:MailKit.ProtocolLogger.Dispose"/> when you are finished using the <see cref="T:MailKit.ProtocolLogger"/>. The
- <see cref="M:MailKit.ProtocolLogger.Dispose"/> method leaves the <see cref="T:MailKit.ProtocolLogger"/> in an unusable state. After calling
- <see cref="M:MailKit.ProtocolLogger.Dispose"/>, you must release all references to the <see cref="T:MailKit.ProtocolLogger"/> so the garbage
- collector can reclaim the memory that the <see cref="T:MailKit.ProtocolLogger"/> was occupying.</remarks>
- </member>
- <member name="T:MailKit.ServiceNotAuthenticatedException">
- <summary>
- The exception that is thrown when the <see cref="T:MailKit.IMailService"/> is not authenticated.
- </summary>
- <remarks>
- This exception is thrown when an operation on a service could not be completed
- due to the service not being authenticated.
- </remarks>
- </member>
- <member name="M:MailKit.ServiceNotAuthenticatedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotAuthenticatedException"/> class.
- </summary>
- <remarks>
- Deserializes a <see cref="T:MailKit.ServiceNotAuthenticatedException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.ServiceNotAuthenticatedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotAuthenticatedException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ServiceNotAuthenticatedException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:MailKit.ServiceNotAuthenticatedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotAuthenticatedException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ServiceNotAuthenticatedException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.ServiceNotAuthenticatedException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotAuthenticatedException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ServiceNotAuthenticatedException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.ServiceNotConnectedException">
- <summary>
- The exception that is thrown when the <see cref="T:MailKit.IMailService"/> is not connected.
- </summary>
- <remarks>
- This exception is thrown when an operation on a service could not be completed
- due to the service not being connected.
- </remarks>
- </member>
- <member name="M:MailKit.ServiceNotConnectedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotConnectedException"/> class.
- </summary>
- <remarks>
- Deserializes a <see cref="T:MailKit.ServiceNotConnectedException"/>.
- </remarks>
- <param name="info">The serialization info.</param>
- <param name="context">The streaming context.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="info"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.ServiceNotConnectedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotConnectedException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ServiceNotConnectedException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:MailKit.ServiceNotConnectedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotConnectedException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ServiceNotConnectedException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.ServiceNotConnectedException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotConnectedException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ServiceNotConnectedException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.SpecialFolder">
- <summary>
- An enumeration of special folders.
- </summary>
- <remarks>
- An enumeration of special folders.
- </remarks>
- </member>
- <member name="F:MailKit.SpecialFolder.All">
- <summary>
- The special folder containing an aggregate of all messages.
- </summary>
- </member>
- <member name="F:MailKit.SpecialFolder.Archive">
- <summary>
- The special folder that contains archived messages.
- </summary>
- </member>
- <member name="F:MailKit.SpecialFolder.Drafts">
- <summary>
- The special folder that contains message drafts.
- </summary>
- </member>
- <member name="F:MailKit.SpecialFolder.Flagged">
- <summary>
- The special folder that contains important messages.
- </summary>
- </member>
- <member name="F:MailKit.SpecialFolder.Junk">
- <summary>
- The special folder that contains spam messages.
- </summary>
- </member>
- <member name="F:MailKit.SpecialFolder.Sent">
- <summary>
- The special folder that contains sent messages.
- </summary>
- </member>
- <member name="F:MailKit.SpecialFolder.Trash">
- <summary>
- The special folder that contains deleted messages.
- </summary>
- </member>
- <member name="T:MailKit.StatusItems">
- <summary>
- Status items.
- </summary>
- <remarks>
- Used with <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- </remarks>
- </member>
- <member name="F:MailKit.StatusItems.None">
- <summary>
- No status requested.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.Count">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.Count"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.Recent">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.Recent"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.UidNext">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.UidNext"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.UidValidity">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.UidValidity"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.Unread">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.Unread"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.HighestModSeq">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.HighestModSeq"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.AppendLimit">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.AppendLimit"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.Size">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.Size"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.MailboxId">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.Id"/>.
- </summary>
- </member>
- <member name="T:MailKit.ThreadingAlgorithm">
- <summary>
- An enumeration of threading algorithms.
- </summary>
- <remarks>
- A threading algorithm is used to group messages and their
- replies together.
- </remarks>
- </member>
- <member name="F:MailKit.ThreadingAlgorithm.OrderedSubject">
- <summary>
- Thread messages based on their Subject headers.
- </summary>
- </member>
- <member name="F:MailKit.ThreadingAlgorithm.References">
- <summary>
- Threads messages based on their References, In-Reply-To, and Message-Id headers.
- This algorithm is far better than <see cref="F:MailKit.ThreadingAlgorithm.OrderedSubject"/> but is also more
- expensive to calculate.
- </summary>
- </member>
- <member name="T:MailKit.UniqueId">
- <summary>
- A unique identifier.
- </summary>
- <remarks>
- Represents a unique identifier for messages in a <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="F:MailKit.UniqueId.Invalid">
- <summary>
- The invalid <see cref="T:MailKit.UniqueId"/> value.
- </summary>
- <remarks>
- The invalid <see cref="T:MailKit.UniqueId"/> value.
- </remarks>
- </member>
- <member name="F:MailKit.UniqueId.MinValue">
- <summary>
- The minimum <see cref="T:MailKit.UniqueId"/> value.
- </summary>
- <remarks>
- The minimum <see cref="T:MailKit.UniqueId"/> value.
- </remarks>
- </member>
- <member name="F:MailKit.UniqueId.MaxValue">
- <summary>
- The maximum <see cref="T:MailKit.UniqueId"/> value.
- </summary>
- <remarks>
- The maximum <see cref="T:MailKit.UniqueId"/> value.
- </remarks>
- </member>
- <member name="M:MailKit.UniqueId.#ctor(System.UInt32,System.UInt32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueId"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.UniqueId"/> with the specified validity and value.
- </remarks>
- <param name="validity">The uid validity.</param>
- <param name="id">The unique identifier.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="id"/> is <c>0</c>.
- </exception>
- </member>
- <member name="M:MailKit.UniqueId.#ctor(System.UInt32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueId"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.UniqueId"/> with the specified value.
- </remarks>
- <param name="id">The unique identifier.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="id"/> is <c>0</c>.
- </exception>
- </member>
- <member name="P:MailKit.UniqueId.Id">
- <summary>
- Gets the identifier.
- </summary>
- <remarks>
- The identifier.
- </remarks>
- <value>The identifier.</value>
- </member>
- <member name="P:MailKit.UniqueId.Validity">
- <summary>
- Gets the validity, if non-zero.
- </summary>
- <remarks>
- Gets the UidValidity of the containing folder.
- </remarks>
- <value>The UidValidity of the containing folder.</value>
- </member>
- <member name="P:MailKit.UniqueId.IsValid">
- <summary>
- Gets whether or not the unique identifier is valid.
- </summary>
- <remarks>
- Gets whether or not the unique identifier is valid.
- </remarks>
- <value><c>true</c> if the unique identifier is valid; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.UniqueId.CompareTo(MailKit.UniqueId)">
- <summary>
- Compares two <see cref="T:MailKit.UniqueId"/> objects.
- </summary>
- <remarks>
- Compares two <see cref="T:MailKit.UniqueId"/> objects.
- </remarks>
- <returns>
- A value less than <c>0</c> if this <see cref="T:MailKit.UniqueId"/> is less than <paramref name="other"/>,
- a value of <c>0</c> if this <see cref="T:MailKit.UniqueId"/> is equal to <paramref name="other"/>, or
- a value greater than <c>0</c> if this <see cref="T:MailKit.UniqueId"/> is greater than <paramref name="other"/>.
- </returns>
- <param name="other">The other unique identifier.</param>
- </member>
- <member name="M:MailKit.UniqueId.Equals(MailKit.UniqueId)">
- <summary>
- Determines whether the specified <see cref="T:MailKit.UniqueId"/> is equal to the current <see cref="T:MailKit.UniqueId"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:MailKit.UniqueId"/> is equal to the current <see cref="T:MailKit.UniqueId"/>.
- </remarks>
- <param name="other">The <see cref="T:MailKit.UniqueId"/> to compare with the current <see cref="T:MailKit.UniqueId"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:MailKit.UniqueId"/> is equal to the current
- <see cref="T:MailKit.UniqueId"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.UniqueId.op_Equality(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Determines whether two unique identifiers are equal.
- </summary>
- <remarks>
- Determines whether two unique identifiers are equal.
- </remarks>
- <returns><c>true</c> if <paramref name="uid1"/> and <paramref name="uid2"/> are equal; otherwise, <c>false</c>.</returns>
- <param name="uid1">The first unique id to compare.</param>
- <param name="uid2">The second unique id to compare.</param>
- </member>
- <member name="M:MailKit.UniqueId.op_GreaterThan(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Determines whether one unique identifier is greater than another unique identifier.
- </summary>
- <remarks>
- Determines whether one unique identifier is greater than another unique identifier.
- </remarks>
- <returns><c>true</c> if <paramref name="uid1"/> is greater than <paramref name="uid2"/>; otherwise, <c>false</c>.</returns>
- <param name="uid1">The first unique id to compare.</param>
- <param name="uid2">The second unique id to compare.</param>
- </member>
- <member name="M:MailKit.UniqueId.op_GreaterThanOrEqual(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Determines whether one unique identifier is greater than or equal to another unique identifier.
- </summary>
- <remarks>
- Determines whether one unique identifier is greater than or equal to another unique identifier.
- </remarks>
- <returns><c>true</c> if <paramref name="uid1"/> is greater than or equal to <paramref name="uid2"/>; otherwise, <c>false</c>.</returns>
- <param name="uid1">The first unique id to compare.</param>
- <param name="uid2">The second unique id to compare.</param>
- </member>
- <member name="M:MailKit.UniqueId.op_Inequality(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Determines whether two unique identifiers are not equal.
- </summary>
- <remarks>
- Determines whether two unique identifiers are not equal.
- </remarks>
- <returns><c>true</c> if <paramref name="uid1"/> and <paramref name="uid2"/> are not equal; otherwise, <c>false</c>.</returns>
- <param name="uid1">The first unique id to compare.</param>
- <param name="uid2">The second unique id to compare.</param>
- </member>
- <member name="M:MailKit.UniqueId.op_LessThan(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Determines whether one unique identifier is less than another unique identifier.
- </summary>
- <remarks>
- Determines whether one unique identifier is less than another unique identifier.
- </remarks>
- <returns><c>true</c> if <paramref name="uid1"/> is less than <paramref name="uid2"/>; otherwise, <c>false</c>.</returns>
- <param name="uid1">The first unique id to compare.</param>
- <param name="uid2">The second unique id to compare.</param>
- </member>
- <member name="M:MailKit.UniqueId.op_LessThanOrEqual(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Determines whether one unique identifier is less than or equal to another unique identifier.
- </summary>
- <remarks>
- Determines whether one unique identifier is less than or equal to another unique identifier.
- </remarks>
- <returns><c>true</c> if <paramref name="uid1"/> is less than or equal to <paramref name="uid2"/>; otherwise, <c>false</c>.</returns>
- <param name="uid1">The first unique id to compare.</param>
- <param name="uid2">The second unique id to compare.</param>
- </member>
- <member name="M:MailKit.UniqueId.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.UniqueId"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.UniqueId"/>.
- </remarks>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.UniqueId"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.UniqueId"/>;
- otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.UniqueId.GetHashCode">
- <summary>
- Serves as a hash function for a <see cref="T:MailKit.UniqueId"/> object.
- </summary>
- <remarks>
- Serves as a hash function for a <see cref="T:MailKit.UniqueId"/> object.
- </remarks>
- <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
- </member>
- <member name="M:MailKit.UniqueId.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueId"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueId"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueId"/>.</returns>
- </member>
- <member name="M:MailKit.UniqueId.TryParse(System.String,System.Int32@,System.UInt32@)">
- <summary>
- Attempt to parse a unique identifier.
- </summary>
- <remarks>
- Attempts to parse a unique identifier.
- </remarks>
- <returns><c>true</c> if the unique identifier was successfully parsed; otherwise, <c>false.</c>.</returns>
- <param name="token">The token to parse.</param>
- <param name="index">The index to start parsing.</param>
- <param name="uid">The unique identifier.</param>
- </member>
- <member name="M:MailKit.UniqueId.TryParse(System.String,System.UInt32,MailKit.UniqueId@)">
- <summary>
- Attempt to parse a unique identifier.
- </summary>
- <remarks>
- Attempts to parse a unique identifier.
- </remarks>
- <returns><c>true</c> if the unique identifier was successfully parsed; otherwise, <c>false.</c>.</returns>
- <param name="token">The token to parse.</param>
- <param name="validity">The UIDVALIDITY value.</param>
- <param name="uid">The unique identifier.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.UniqueId.TryParse(System.String,MailKit.UniqueId@)">
- <summary>
- Attempt to parse a unique identifier.
- </summary>
- <remarks>
- Attempts to parse a unique identifier.
- </remarks>
- <returns><c>true</c> if the unique identifier was successfully parsed; otherwise, <c>false.</c>.</returns>
- <param name="token">The token to parse.</param>
- <param name="uid">The unique identifier.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.UniqueId.Parse(System.String,System.UInt32)">
- <summary>
- Parse a unique identifier.
- </summary>
- <remarks>
- Parses a unique identifier.
- </remarks>
- <returns>The unique identifier.</returns>
- <param name="token">A string containing the unique identifier.</param>
- <param name="validity">The UIDVALIDITY.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.FormatException">
- <paramref name="token"/> is not in the correct format.
- </exception>
- <exception cref="T:System.OverflowException">
- The unique identifier is greater than <see cref="F:MailKit.UniqueId.MaxValue"/>.
- </exception>
- </member>
- <member name="M:MailKit.UniqueId.Parse(System.String)">
- <summary>
- Parse a unique identifier.
- </summary>
- <remarks>
- Parses a unique identifier.
- </remarks>
- <returns>The unique identifier.</returns>
- <param name="token">A string containing the unique identifier.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.FormatException">
- <paramref name="token"/> is not in the correct format.
- </exception>
- <exception cref="T:System.OverflowException">
- The unique identifier is greater than <see cref="F:MailKit.UniqueId.MaxValue"/>.
- </exception>
- </member>
- <member name="T:MailKit.UniqueIdMap">
- <summary>
- A mapping of unique identifiers.
- </summary>
- <remarks>
- <para>A <see cref="T:MailKit.UniqueIdMap"/> can be used to discover the mapping of one set of unique identifiers
- to another.</para>
- <para>For example, when copying or moving messages from one folder to another, it is often desirable
- to know what the unique identifiers are for each of the messages in the destination folder.</para>
- </remarks>
- </member>
- <member name="F:MailKit.UniqueIdMap.Empty">
- <summary>
- Any empty mapping of unique identifiers.
- </summary>
- <remarks>
- Any empty mapping of unique identifiers.
- </remarks>
- </member>
- <member name="M:MailKit.UniqueIdMap.#ctor(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.UniqueId})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdMap"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.UniqueIdMap"/>.
- </remarks>
- <param name="source">The unique identifiers used in the source folder.</param>
- <param name="destination">The unique identifiers used in the destination folder.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="source"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.UniqueIdMap.Source">
- <summary>
- Gets the list of unique identifiers used in the source folder.
- </summary>
- <remarks>
- Gets the list of unique identifiers used in the source folder.
- </remarks>
- <value>The unique identifiers used in the source folder.</value>
- </member>
- <member name="P:MailKit.UniqueIdMap.Destination">
- <summary>
- Gets the list of unique identifiers used in the destination folder.
- </summary>
- <remarks>
- Gets the list of unique identifiers used in the destination folder.
- </remarks>
- <value>The unique identifiers used in the destination folder.</value>
- </member>
- <member name="P:MailKit.UniqueIdMap.Count">
- <summary>
- Gets the number of unique identifiers that have been remapped.
- </summary>
- <remarks>
- Gets the number of unique identifiers that have been remapped.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="P:MailKit.UniqueIdMap.Keys">
- <summary>
- Gets the keys.
- </summary>
- <remarks>
- Gets the keys.
- </remarks>
- <value>The keys.</value>
- </member>
- <member name="P:MailKit.UniqueIdMap.Values">
- <summary>
- Gets the values.
- </summary>
- <remarks>
- Gets the values.
- </remarks>
- <value>The values.</value>
- </member>
- <member name="M:MailKit.UniqueIdMap.ContainsKey(MailKit.UniqueId)">
- <summary>
- Checks if the specified unique identifier has been remapped.
- </summary>
- <remarks>
- Checks if the specified unique identifier has been remapped.
- </remarks>
- <returns><c>true</c> if the unique identifier has been remapped; otherwise, <c>false</c>.</returns>
- <param name="key">The unique identifier.</param>
- </member>
- <member name="M:MailKit.UniqueIdMap.TryGetValue(MailKit.UniqueId,MailKit.UniqueId@)">
- <summary>
- Tries to get the remapped unique identifier.
- </summary>
- <remarks>
- Attempts to get the remapped unique identifier.
- </remarks>
- <returns><c>true</c> on success; otherwise, <c>false</c>.</returns>
- <param name="key">The unique identifier of the message in the source folder.</param>
- <param name="value">The unique identifier of the message in the destination folder.</param>
- </member>
- <member name="P:MailKit.UniqueIdMap.Item(MailKit.UniqueId)">
- <summary>
- Gets the remapped unique identifier.
- </summary>
- <remarks>
- Gets the remapped unique identifier.
- </remarks>
- <param name="index">The unique identifier of the message in the source folder.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdMap.GetEnumerator">
- <summary>
- Gets the enumerator for the remapped unique identifiers.
- </summary>
- <remarks>
- Gets the enumerator for the remapped unique identifiers.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.UniqueIdMap.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Gets the enumerator for the remapped unique identifiers.
- </summary>
- <remarks>
- Gets the enumerator for the remapped unique identifiers.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="T:MailKit.UniqueIdRange">
- <summary>
- A range of <see cref="T:MailKit.UniqueId"/> items.
- </summary>
- <remarks>
- When dealing with a large range, it is more efficient to use a
- <see cref="T:MailKit.UniqueIdRange"/> than a typical
- IList<<see cref="T:MailKit.UniqueId"/>>.
- </remarks>
- </member>
- <member name="F:MailKit.UniqueIdRange.All">
- <summary>
- A <see cref="T:MailKit.UniqueIdRange"/> that encompases all messages in the folder.
- </summary>
- <remarks>
- Represents the range of messages from <see cref="F:MailKit.UniqueId.MinValue"/> to
- <see cref="F:MailKit.UniqueId.MaxValue"/>.
- </remarks>
- </member>
- <member name="M:MailKit.UniqueIdRange.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdRange"/> class.
- </summary>
- <remarks>
- Creates a new (invalid) range of unique identifiers.
- </remarks>
- </member>
- <member name="M:MailKit.UniqueIdRange.#ctor(System.UInt32,System.UInt32,System.UInt32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdRange"/> class.
- </summary>
- <remarks>
- Creates a new range of unique identifiers.
- </remarks>
- <param name="validity">The uid validity.</param>
- <param name="start">The first unique identifier in the range.</param>
- <param name="end">The last unique identifier in the range.</param>
- </member>
- <member name="M:MailKit.UniqueIdRange.#ctor(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdRange"/> class.
- </summary>
- <remarks>
- Creates a new range of unique identifiers.
- </remarks>
- <param name="start">The first <see cref="T:MailKit.UniqueId"/> in the range.</param>
- <param name="end">The last <see cref="T:MailKit.UniqueId"/> in the range.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="start"/> is invalid.</para>
- <para>-or-</para>
- <para><paramref name="end"/> is invalid.</para>
- </exception>
- </member>
- <member name="P:MailKit.UniqueIdRange.Validity">
- <summary>
- Gets the validity, if non-zero.
- </summary>
- <remarks>
- Gets the UidValidity of the containing folder.
- </remarks>
- <value>The UidValidity of the containing folder.</value>
- </member>
- <member name="P:MailKit.UniqueIdRange.Min">
- <summary>
- Gets the minimum unique identifier in the range.
- </summary>
- <remarks>
- Gets the minimum unique identifier in the range.
- </remarks>
- <value>The minimum unique identifier.</value>
- </member>
- <member name="P:MailKit.UniqueIdRange.Max">
- <summary>
- Gets the maximum unique identifier in the range.
- </summary>
- <remarks>
- Gets the maximum unique identifier in the range.
- </remarks>
- <value>The maximum unique identifier.</value>
- </member>
- <member name="P:MailKit.UniqueIdRange.Start">
- <summary>
- Get the start of the unique identifier range.
- </summary>
- <remarks>
- Gets the start of the unique identifier range.
- </remarks>
- <value>The start of the range.</value>
- </member>
- <member name="P:MailKit.UniqueIdRange.End">
- <summary>
- Get the end of the unique identifier range.
- </summary>
- <remarks>
- Gets the end of the unique identifier range.
- </remarks>
- <value>The end of the range.</value>
- </member>
- <member name="P:MailKit.UniqueIdRange.Count">
- <summary>
- Get the number of unique identifiers in the range.
- </summary>
- <remarks>
- Gets the number of unique identifiers in the range.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="P:MailKit.UniqueIdRange.IsReadOnly">
- <summary>
- Get whether or not the range is read only.
- </summary>
- <remarks>
- A <see cref="T:MailKit.UniqueIdRange"/> is always read-only.
- </remarks>
- <value><c>true</c> if the range is read only; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.UniqueIdRange.Add(MailKit.UniqueId)">
- <summary>
- Adds the unique identifier to the range.
- </summary>
- <remarks>
- Since a <see cref="T:MailKit.UniqueIdRange"/> is read-only, unique ids cannot
- be added to the range.
- </remarks>
- <param name="uid">The unique identifier to add.</param>
- <exception cref="T:System.NotSupportedException">
- The list does not support adding items.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.Clear">
- <summary>
- Clears the list.
- </summary>
- <remarks>
- Since a <see cref="T:MailKit.UniqueIdRange"/> is read-only, the range cannot be cleared.
- </remarks>
- <exception cref="T:System.NotSupportedException">
- The list does not support being cleared.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.Contains(MailKit.UniqueId)">
- <summary>
- Checks if the range contains the specified unique id.
- </summary>
- <remarks>
- Determines whether or not the range contains the specified unique id.
- </remarks>
- <returns><value>true</value> if the specified unique identifier is in the range; otherwise <value>false</value>.</returns>
- <param name="uid">The unique id.</param>
- </member>
- <member name="M:MailKit.UniqueIdRange.CopyTo(MailKit.UniqueId[],System.Int32)">
- <summary>
- Copies all of the unique ids in the range to the specified array.
- </summary>
- <remarks>
- Copies all of the unique ids within the range into the array,
- starting at the specified array index.
- </remarks>
- <param name="array">The array to copy the unique ids to.</param>
- <param name="arrayIndex">The index into the array.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="array"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="arrayIndex"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.Remove(MailKit.UniqueId)">
- <summary>
- Removes the unique identifier from the range.
- </summary>
- <remarks>
- Since a <see cref="T:MailKit.UniqueIdRange"/> is read-only, unique ids cannot be removed.
- </remarks>
- <returns><value>true</value> if the unique identifier was removed; otherwise <value>false</value>.</returns>
- <param name="uid">The unique identifier to remove.</param>
- <exception cref="T:System.NotSupportedException">
- The list does not support removing items.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.IndexOf(MailKit.UniqueId)">
- <summary>
- Gets the index of the specified unique id, if it exists.
- </summary>
- <remarks>
- Finds the index of the specified unique id, if it exists.
- </remarks>
- <returns>The index of the specified unique id; otherwise <value>-1</value>.</returns>
- <param name="uid">The unique id.</param>
- </member>
- <member name="M:MailKit.UniqueIdRange.Insert(System.Int32,MailKit.UniqueId)">
- <summary>
- Inserts the specified unique identifier at the given index.
- </summary>
- <remarks>
- Inserts the unique identifier at the specified index in the range.
- </remarks>
- <param name="index">The index to insert the unique id.</param>
- <param name="uid">The unique id.</param>
- <exception cref="T:System.NotSupportedException">
- The list does not support inserting items.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.RemoveAt(System.Int32)">
- <summary>
- Removes the unique identifier at the specified index.
- </summary>
- <remarks>
- Removes the unique identifier at the specified index.
- </remarks>
- <param name="index">The index.</param>
- <exception cref="T:System.NotSupportedException">
- The list does not support removing items.
- </exception>
- </member>
- <member name="P:MailKit.UniqueIdRange.Item(System.Int32)">
- <summary>
- Gets or sets the unique identifier at the specified index.
- </summary>
- <remarks>
- Gets or sets the unique identifier at the specified index.
- </remarks>
- <value>The unique identifier at the specified index.</value>
- <param name="index">The index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The list does not support setting items.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.GetEnumerator">
- <summary>
- Gets an enumerator for the range of unique ids.
- </summary>
- <remarks>
- Gets an enumerator for the range of unique ids.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.UniqueIdRange.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Gets an enumerator for the range of unique ids.
- </summary>
- <remarks>
- Gets an enumerator for the range of unique ids.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.UniqueIdRange.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdRange"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdRange"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdRange"/>.</returns>
- </member>
- <member name="M:MailKit.UniqueIdRange.TryParse(System.String,System.UInt32,MailKit.UniqueIdRange@)">
- <summary>
- Attempt to parse a unique identifier range.
- </summary>
- <remarks>
- Attempts to parse a unique identifier range.
- </remarks>
- <returns><c>true</c> if the unique identifier range was successfully parsed; otherwise, <c>false.</c>.</returns>
- <param name="token">The token to parse.</param>
- <param name="validity">The UIDVALIDITY value.</param>
- <param name="range">The unique identifier range.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.TryParse(System.String,MailKit.UniqueIdRange@)">
- <summary>
- Attempt to parse a unique identifier range.
- </summary>
- <remarks>
- Attempts to parse a unique identifier range.
- </remarks>
- <returns><c>true</c> if the unique identifier range was successfully parsed; otherwise, <c>false.</c>.</returns>
- <param name="token">The token to parse.</param>
- <param name="range">The unique identifier range.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.UniqueIdSet">
- <summary>
- A set of unique identifiers.
- </summary>
- <remarks>
- When dealing with a large number of unique identifiers, it may be more efficient to use a
- <see cref="T:MailKit.UniqueIdSet"/> than a typical IList<<see cref="T:MailKit.UniqueId"/>>.
- </remarks>
- </member>
- <member name="M:MailKit.UniqueIdSet.#ctor(System.UInt32,MailKit.Search.SortOrder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdSet"/> class.
- </summary>
- <remarks>
- Creates a new unique identifier set.
- </remarks>
- <param name="validity">The uid validity.</param>
- <param name="order">The sorting order to use for the unique identifiers.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="order"/> is invalid.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.#ctor(MailKit.Search.SortOrder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdSet"/> class.
- </summary>
- <remarks>
- Creates a new unique identifier set.
- </remarks>
- <param name="order">The sorting order to use for the unique identifiers.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="order"/> is invalid.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.#ctor(System.Collections.Generic.IEnumerable{MailKit.UniqueId},MailKit.Search.SortOrder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdSet"/> class.
- </summary>
- <remarks>
- Creates a new set of unique identifier set containing the specified uids.
- </remarks>
- <param name="uids">An initial set of unique ids.</param>
- <param name="order">The sorting order to use for the unique identifiers.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="order"/> is invalid.
- </exception>
- </member>
- <member name="P:MailKit.UniqueIdSet.SortOrder">
- <summary>
- Gets the sort order of the unique identifiers.
- </summary>
- <remarks>
- Gets the sort order of the unique identifiers.
- </remarks>
- <value>The sort order.</value>
- </member>
- <member name="P:MailKit.UniqueIdSet.Validity">
- <summary>
- Gets the validity, if non-zero.
- </summary>
- <remarks>
- Gets the UidValidity of the containing folder.
- </remarks>
- <value>The UidValidity of the containing folder.</value>
- </member>
- <member name="P:MailKit.UniqueIdSet.Count">
- <summary>
- Get the number of unique ids in the set.
- </summary>
- <remarks>
- Gets the number of unique ids in the set.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="P:MailKit.UniqueIdSet.IsReadOnly">
- <summary>
- Get whether or not the set is read only.
- </summary>
- <remarks>
- Gets whether or not the set is read-only.
- </remarks>
- <value><c>true</c> if the set is read only; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.UniqueIdSet.Add(MailKit.UniqueId)">
- <summary>
- Adds the unique identifier to the set.
- </summary>
- <remarks>
- Adds the unique identifier to the set.
- </remarks>
- <param name="uid">The unique identifier to add.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.AddRange(System.Collections.Generic.IEnumerable{MailKit.UniqueId})">
- <summary>
- Adds all of the uids to the set.
- </summary>
- <remarks>
- Adds all of the uids to the set.
- </remarks>
- <param name="uids">The collection of uids.</param>
- </member>
- <member name="M:MailKit.UniqueIdSet.Clear">
- <summary>
- Clears the list.
- </summary>
- <remarks>
- Clears the list.
- </remarks>
- <exception cref="T:System.InvalidOperationException">
- The collection is readonly.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.Contains(MailKit.UniqueId)">
- <summary>
- Checks if the set contains the specified unique id.
- </summary>
- <remarks>
- Determines whether or not the set contains the specified unique id.
- </remarks>
- <returns><value>true</value> if the specified unique identifier is in the set; otherwise <value>false</value>.</returns>
- <param name="uid">The unique id.</param>
- </member>
- <member name="M:MailKit.UniqueIdSet.CopyTo(MailKit.UniqueId[],System.Int32)">
- <summary>
- Copies all of the unique ids in the set to the specified array.
- </summary>
- <remarks>
- Copies all of the unique ids within the set into the array,
- starting at the specified array index.
- </remarks>
- <param name="array">The array to copy the unique ids to.</param>
- <param name="arrayIndex">The index into the array.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="array"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="arrayIndex"/> is out of set.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.Remove(MailKit.UniqueId)">
- <summary>
- Removes the unique identifier from the set.
- </summary>
- <remarks>
- Removes the unique identifier from the set.
- </remarks>
- <returns><value>true</value> if the unique identifier was removed; otherwise <value>false</value>.</returns>
- <param name="uid">The unique identifier to remove.</param>
- </member>
- <member name="M:MailKit.UniqueIdSet.IndexOf(MailKit.UniqueId)">
- <summary>
- Gets the index of the specified unique id, if it exists.
- </summary>
- <remarks>
- Finds the index of the specified unique id, if it exists.
- </remarks>
- <returns>The index of the specified unique id; otherwise <value>-1</value>.</returns>
- <param name="uid">The unique id.</param>
- </member>
- <member name="M:MailKit.UniqueIdSet.Insert(System.Int32,MailKit.UniqueId)">
- <summary>
- Inserts the specified unique identifier at the given index.
- </summary>
- <remarks>
- Inserts the unique identifier at the specified index in the set.
- </remarks>
- <param name="index">The index to insert the unique id.</param>
- <param name="uid">The unique id.</param>
- <exception cref="T:System.NotSupportedException">
- The list does not support inserting items.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.RemoveAt(System.Int32)">
- <summary>
- Removes the unique identifier at the specified index.
- </summary>
- <remarks>
- Removes the unique identifier at the specified index.
- </remarks>
- <param name="index">The index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="P:MailKit.UniqueIdSet.Item(System.Int32)">
- <summary>
- Gets or sets the unique identifier at the specified index.
- </summary>
- <remarks>
- Gets or sets the unique identifier at the specified index.
- </remarks>
- <value>The unique identifier at the specified index.</value>
- <param name="index">The index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The list does not support setting items.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.GetEnumerator">
- <summary>
- Gets an enumerator for the set of unique ids.
- </summary>
- <remarks>
- Gets an enumerator for the set of unique ids.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.UniqueIdSet.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Gets an enumerator for the set of unique ids.
- </summary>
- <remarks>
- Gets an enumerator for the set of unique ids.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.UniqueIdSet.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdSet"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdSet"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdSet"/>.</returns>
- </member>
- <member name="M:MailKit.UniqueIdSet.ToString(System.Collections.Generic.IList{MailKit.UniqueId})">
- <summary>
- Format a generic list of unique identifiers as a string.
- </summary>
- <remarks>
- Formats a generic list of unique identifiers as a string.
- </remarks>
- <returns>The string representation of the collection of unique identifiers.</returns>
- <param name="uids">The unique identifiers.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the unique identifiers is invalid (has a value of <c>0</c>).
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.EnumerateSerializedSubsets(System.Int32)">
- <summary>
- Format the set of unique identifiers as multiple strings that fit within the maximum defined character length.
- </summary>
- <remarks>
- Formats the set of unique identifiers as multiple strings that fit within the maximum defined character length.
- </remarks>
- <returns>A list of strings representing the collection of unique identifiers.</returns>
- <param name="maxLength">The maximum length of any returned string of UIDs.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="maxLength"/> is negative.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.EnumerateSerializedSubsets(System.Collections.Generic.IList{MailKit.UniqueId},System.Int32)">
- <summary>
- Format a generic list of unique identifiers as multiple strings that fit within the maximum defined character length.
- </summary>
- <remarks>
- Formats a generic list of unique identifiers as multiple strings that fit within the maximum defined character length.
- </remarks>
- <returns>A list of strings representing the collection of unique identifiers.</returns>
- <param name="uids">The unique identifiers.</param>
- <param name="maxLength">The maximum length of any returned string of UIDs.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the unique identifiers is invalid (has a value of <c>0</c>).
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="maxLength"/> is negative.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.TryParse(System.String,System.UInt32,MailKit.UniqueIdSet@)">
- <summary>
- Attempt to parse the specified token as a set of unique identifiers.
- </summary>
- <remarks>
- Attempts to parse the specified token as a set of unique identifiers.
- </remarks>
- <returns><c>true</c> if the set of unique identifiers were successfully parsed; otherwise, <c>false</c>.</returns>
- <param name="token">The token containing the set of unique identifiers.</param>
- <param name="validity">The UIDVALIDITY value.</param>
- <param name="uids">The set of unique identifiers.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.TryParse(System.String,MailKit.UniqueIdSet@)">
- <summary>
- Attempt to parse the specified token as a set of unique identifiers.
- </summary>
- <remarks>
- Attempts to parse the specified token as a set of unique identifiers.
- </remarks>
- <returns><c>true</c> if the set of unique identifiers were successfully parsed; otherwise, <c>false</c>.</returns>
- <param name="token">The token containing the set of unique identifiers.</param>
- <param name="uids">The set of unique identifiers.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- </member>
- </members>
- </doc>
|